docs(website): comprehensive documentation rewrite#35
Merged
Conversation
Add 4 new documentation pages: - Concepts: Specification-Driven Development (SDD methodology explanation) - Concepts: Vertical Slices (task structure explanation) - Troubleshooting (common issues and fixes) - Changelog (release history with links to GitHub) Update docs homepage and sidebar navigation to include the new sections.
…analysis Rewrote nearly every documentation page based on deep analysis of the actual source code (CLI, Web UI, AI agents, API/integrations). Key changes: - CLI reference: added approve, finalize-scope, break commands, --trace flag - Output files: added full JSON schemas for all file formats - Settings reference: new page covering all configurable options - All 5 workflow pages: rewritten with actual agent behavior, question depth settings, decision tracking, review options - Web UI guide: rewritten covering every screen and interaction - Ship to AI Tools: added headless vs keyboard automation, prompt structure - Linear integration: added 6-step sync flow, estimation mapping - Concepts pages: enhanced with complexity scoring, testing philosophy - Troubleshooting: rewritten with actual error messages and solutions - Playbooks & customizing-agents: enhanced with specific details - Getting started: updated with init details, playbook prompt, review options 20 files changed (+1,499 / -425 lines), website builds successfully (24 pages).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrote the documentation site from source-level analysis of the SpecWright codebase. The initial docs were too light — this PR adds complete coverage of CLI commands, output file schemas, all settings, detailed workflow explanations, Web UI interactions, ship/Linear integration flows, and troubleshooting.
24 files changed (+1882 / -386 lines). Website builds clean with all pages rendered. Key additions: CLI reference (approve, finalize-scope, break, --trace), output files reference (full JSON schemas), new settings reference page, rewritten workflow pages (question depth, decision tracking, review options), complete Web UI guide, headless vs keyboard automation documentation, 6-step Linear sync flow, and enhanced concepts/troubleshooting.