Skip to content

docs(v3): Restructure documentation - remove numbered prefixes, consolidate sections#89

Merged
doriwilson merged 8 commits intomainfrom
review-merged-docsv3
Mar 12, 2026
Merged

docs(v3): Restructure documentation - remove numbered prefixes, consolidate sections#89
doriwilson merged 8 commits intomainfrom
review-merged-docsv3

Conversation

@ijac13
Copy link
Copy Markdown
Contributor

@ijac13 ijac13 commented Mar 11, 2026

Summary

Complete documentation restructure to improve navigation and maintainability:

  • Remove numbered prefixes from all folders (1-whats-reccewhats-recce, etc.)
  • Consolidate sections: merge visualized-change, downstream-impacts, data-diffing into what-you-can-explore
  • Reorganize setup: move setup files from getting-started to dedicated setup-guides folder
  • New pages: activity.md, oss-workflow.md, cli-commands.md, summary.md
  • 61 URL redirects for backwards compatibility
  • All internal links and image paths updated

New Structure

docs/
├── index.md
├── whats-recce/
├── getting-started/
├── setup-guides/
├── using-recce/
├── what-you-can-explore/
├── collaboration/
└── technical-concepts/

Changes

Folder Restructure

From To
1-whats-recce/ whats-recce/
2-getting-started/ getting-started/ + setup-guides/
3-using-recce/ using-recce/
3-visualized-change/, 4-downstream-impacts/, 5-data-diffing/, 5-what-you-can-explore/ what-you-can-explore/
6-collaboration/ collaboration/
7-reference/, 8-technical-concepts/ technical-concepts/

New Pages

  • collaboration/activity.md - Per-check activity tracking
  • using-recce/oss-workflow.md - OSS-specific workflow guide
  • using-recce/cli-commands.md - CLI reference (Cloud + OSS)
  • what-you-can-explore/summary.md - Data Review Summary feature

Redirects

61 redirect rules added to mkdocs.yml covering all old numbered paths.

Test Plan

  • mkdocs build succeeds
  • All 61 redirect HTML files generated correctly
  • Internal links verified across all documentation
  • Image paths updated and verified
  • Manual review of navigation flow
  • Redirects tested locally via mkdocs serve

🤖 Generated with Claude Code

ijac13 and others added 3 commits March 11, 2026 09:46
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…tion

- Create summary.md from pr-mr-summary.md with agent summary structure
- Remove 4-what-the-agent-does/ section (duplicated content)
- Update data-developer.md with checklist guidance and verification steps
- Update data-reviewer.md with review workflow and PR blocking checks
- Add checklist.md details for descriptions and approving checks
- Add internal links between workflow pages and what-you-can-explore
- Update jaffle-shop-tutorial.md to clarify OSS-only scope

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove numbered prefixes from all folders (1-whats-recce → whats-recce, etc.)
- Consolidate sections: merge 3-visualized-change, 4-downstream-impacts, 5-data-diffing into what-you-can-explore
- Move setup files from 2-getting-started to setup-guides
- Create new pages: activity.md, oss-workflow.md, cli-commands.md, summary.md
- Update all internal links and image paths
- Add 61 URL redirects for backwards compatibility
- Fix broken links across all documentation
- Verify mkdocs build succeeds with all redirects working

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@ijac13 ijac13 requested a review from doriwilson March 11, 2026 17:10
ijac13 and others added 5 commits March 12, 2026 11:23
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add --port option to recce server command
- Add recce --help reference
- Add troubleshooting for port conflicts
- Add troubleshooting for summary review mode error

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@doriwilson doriwilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks for fixing up the redundancies.

@doriwilson doriwilson merged commit 7f8b4ae into main Mar 12, 2026
@doriwilson doriwilson deleted the review-merged-docsv3 branch March 12, 2026 20:38
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.

2 participants