Skip to main content

​
HOW TO REVIEW TIER 1 DOCUMENTATION

Quick review checklist for approval

​
🎯 WHAT TO CHECK (10 minutes)

​
1. Pick 3 Random Articles (5 min)

Open in the docs repo and skim:
  • Does the content match the current product?
  • Are the steps accurate?
  • Do image captions make sense?
Suggested articles to spot-check:
  • /tmp/mintlify-docs/en/cowork/digital-employees/configuracao-basica/criando-um-digital-employee.mdx (most complex — has 6 steps)
  • /tmp/mintlify-docs/en/cowork/mesh-canvas/mesh-canvas-overview.mdx (visual explanation)
  • /tmp/mintlify-docs/en/cowork/artifacts/artifact-management.mdx (common user workflow)

​
2. Check Navigation Structure (3 min)

Does the hierarchy in docs.json match your intended user journey?
  • Getting Started → Digital Employees (9 subsections) → Mesh Canvas → Artifacts → Squads
File: /tmp/mintlify-docs/docs.json (lines 60-150 for EN Cowork tab)

​
3. Terminology Alignment (2 min)

Scan for these terms — are they used consistently?
  • “Digital Employee” vs “Autopilot” vs “Agent” — which term is canonical?
  • “Artifacts” vs “Documents” vs “Outputs”
  • “Mesh Canvas” vs “Canvas” — is the full name always used first?

​
❌ RED FLAGS TO LOOK FOR

  • Outdated product screenshots (check UI elements match current Cowork)
  • References to removed features or deprecated workflows
  • Inconsistent terminology within the same article or across articles
  • Steps that don’t align with your UI flow
  • Missing images (articles should not have blank <Frame> tags — all should have image paths)

​
✅ APPROVAL TEMPLATE

When ready, send approval like this:

​
📂 FILE LOCATIONS

Main docs: /tmp/mintlify-docs/
EN articles: /tmp/mintlify-docs/en/cowork/
Navigation: /tmp/mintlify-docs/docs.json
Checklist: /tmp/mintlify-docs/TIER1_SCREENSHOTS_CHECKLIST.md
Report: /tmp/mintlify-docs/TIER1_FINALIZATION_REPORT.md

​
💡 TIPS FOR QUICK REVIEW

  • Use VSCode or your editor’s Markdown preview to see formatted content
  • Look for {/* SCREENSHOT NEEDED */} comments — should be 0 in TIER 1 (all complete)
  • Check that internal links like [Mesh Canvas Navigation](/en/cowork/mesh-canvas/navigation-interaction) are correct
  • Skim the what-is-cowork.mdx intro — it should be the “north star” that all other articles ladder off

​
🚀 NEXT STEP AFTER APPROVAL

Once you approve, I will immediately proceed to create TIER 2 placeholders with the same structure:
  • Detailed Configuration (Budget, Work Instructions, Rollback)
  • Advanced Monitoring (Planner Journal, Metrics, Cost)
  • Governance (Hierarchy, Permissions, Audit)
  • Real-Time Collaboration (Presence, Follow, Sync Sessions)
  • Project Rooms (Concept, Management, Artifacts)
Each with clear _TODO_ markers and {/* SCREENSHOT NEEDED */} placeholders showing exactly what images you need to add.