docs: Prompt Library and advanced site features (Phase 2) #125
Description
Summary
Phase 2 of documentation refactor - add advanced features to VitePress documentation site after basic migration from README is complete.
Depends on: #24 (VitePress foundation + README migration)
Prompt Library (Best Practice from Figma/PandaDoc)
Based on 5 Examples of Excellent MCP Documentation, top MCP servers provide ready-to-use prompts.
Structure
docs/prompts/
├── index.md # "How to get the best output"
├── quick-start/
│ ├── first-steps.md # "List my projects"
│ ├── explore-repo.md # "Show me recent changes"
│ └── check-status.md # "What MRs need attention"
├── code-review/
│ ├── review-mr.md # Full review workflow
│ ├── suggest-changes.md # Adding suggestions
│ └── apply-feedback.md # Applying suggestions
├── ci-cd/
│ ├── debug-failure.md # "Why did the build fail?"
│ ├── check-status.md # Pipeline health
│ └── trigger-deploy.md # Deployment prompts
├── project-management/
│ ├── sprint-planning.md # Milestone management
│ ├── issue-triage.md # Issue organization
│ └── release-notes.md # Generate changelogs
└── by-role/
├── developer.md # Dev-focused prompts
├── devops.md # Ops-focused prompts
├── team-lead.md # Lead-focused prompts
└── pm.md # PM-focused prompts
Step-by-Step Guides
| Guide | Description | Tools Used |
|---|---|---|
| Complete Code Review | End-to-end MR review process | browse_merge_requests, manage_mr_discussion |
| Setup CI Notifications | Pipeline alerts to Slack/Discord | manage_webhook, manage_integration |
| Automate Releases | Release workflow with changelogs | manage_release, browse_commits |
| Multi-GitLab Setup | Multiple instances with profiles | manage_context |
| Team Onboarding | Getting team started | browse_projects, list_project_members |
Tasks
Prompt Library
- Create
docs/prompts/index.mdwith best practices - Write quick-start prompts (first-steps, explore-repo, check-status)
- Write code-review prompts (review-mr, suggest-changes, apply-feedback)
- Write ci-cd prompts (debug-failure, check-status, trigger-deploy)
- Write project-management prompts (sprint-planning, issue-triage, release-notes)
- Write role-based prompt collections (developer, devops, team-lead, pm)
Step-by-Step Guides
-
docs/guides/complete-code-review.md -
docs/guides/setup-ci-notifications.md -
docs/guides/automate-releases.md -
docs/guides/multi-gitlab-setup.md -
docs/guides/team-onboarding.md
LLMS.txt
- Create
docs/public/llms.txt - Ensure all 47 tools are listed
- Test with AI clients
Site Enhancements
- Reorganize tools by use-case (code-review, ci-cd, project-management, repository)
- Add role-based navigation (nav + sidebar + by-role prompts)
- Add interactive code examples (VitePress code-group tabs)
- Add tool comparison tables (by-role + CQRS)
Acceptance Criteria
- Prompt library with 20+ ready-to-use prompts (16 pages, 60+ prompts)
- 5+ step-by-step guides (5 guides)
- LLMS.txt available at site root
- Tools organized by use-case (4 use-case pages)
- Role-based navigation works
- All examples are tested and work
References
- 5 Examples of Excellent MCP Documentation
- Figma MCP - Prompt library pattern
- PandaDoc MCP - Workflow prompts
- SmartBear MCP - Detailed tool descriptions