Skip to content

Conversation

AbdulSamad94
Copy link

@AbdulSamad94 AbdulSamad94 commented Oct 1, 2025

This PR fixes inconsistencies between the main README.md and the documentation site.

Fixes #530

Previously, the docs were missing important details that were present in README, which caused confusion for users.

Changes Made

  • Updated installation.md to include persistent installation option and all supported AI agents
  • Enhanced quickstart.md with full 6-step process including missing /constitution and /analyze commands
  • Added comprehensive CLI reference documentation as a new page
  • Updated local-development.md with examples for all supported AI agents
  • Added Supported AI Agents table to index.md
  • Updated table of contents and docfx.json to include new documentation

Why This Matters

  • Ensures consistency between README.md and docs site
  • Properly documents missing features and commands
  • Reflects actual capabilities across all docs
  • Provides new users with complete installation and usage instructions

Testing

  • Verified all links work correctly
  • Confirmed documentation builds successfully with changes

- Add missing persistent installation option to installation.md
- Include all AI agents in prerequisites across documentation
- Add missing /constitution and /analyze commands to quickstart guide
- Create comprehensive CLI reference documentation
- Update local-development.md with all AI agents in examples
- Ensure all documentation files are consistent with README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Documentation and Site Outdated – Difficult to Use Without Proper Guides

1 participant