mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-08-02 06:47:43 -05:00
1.5 KiB
1.5 KiB
1. VitePress Config Updates
- 1.1 Add "AI" top-level nav item to
docs/.vitepress/config.mjswith sub-items: AI Writing (/ai/writing), AI Review (/ai/review), MCP Servers (/ai/mcp-servers) - 1.2 Add "AI" sidebar group to
docs/.vitepress/config.mjswith entries: Overview (/ai/), Writing (/ai/writing), Review (/ai/review), MCP Servers (/ai/mcp-servers)
2. AI Section Pages
- 2.1 Create
docs/ai/index.md— landing page with overview of all three sub-pages and brief descriptions of each area - 2.2 Create
docs/ai/writing.md— AI writing assistants section and agent skills/prompts section for technical writing - 2.3 Create
docs/ai/review.md— AI review tools section and agent skills/prompts section for documentation review - 2.4 Create
docs/ai/mcp-servers.md— MCP introduction, Vale MCP server entry, and contribution invitation
3. Cross-References in Existing Pages
- 3.1 Add cross-reference in
docs/writing.mdpointing to/ai/writingfor AI-specific writing tools - 3.2 Add cross-reference in
docs/quality.mdpointing to/ai/reviewfor AI-specific review tools - 3.3 Add AI section entry to the Categories Overview in
docs/index.md
4. Verification
- 4.1 Run
pnpm docs:devand verify all four AI pages render correctly - 4.2 Verify the AI nav item and sidebar group appear and all links resolve
- 4.3 Verify cross-references in
docs/writing.mdanddocs/quality.mdlink correctly - 4.4 Verify
docs/index.mdCategories Overview includes the AI section link