docs: update documentation structure and workflow references #18
Conversation
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
Reorganize documentation to reflect current repository state: - Move docs/quickstart.md to docs/README.md for better discoverability - Delete redundant docs/index.md - Update CLAUDE.md with accurate repository structure - Document new codebase-agent.yml workflow and automation scripts - Update all cross-references to new doc paths in README and PRESENTATION Changes to CLAUDE.md: - Add .github/scripts/codebase_agent/ automation module - Document all 5 GitHub Actions workflows (was 2) - Update docs/ structure to reflect standalone patterns approach - Remove references to deleted architecture.md, tutorial.md, api-reference.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Update ci.yml to check for docs/README.md instead of docs/quickstart.md and remove check for deleted docs/index.md. Add check for docs/adr/. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Reorganize documentation to reflect current repository state and improve discoverability.
Changes
Documentation Reorganization:
docs/quickstart.md→docs/README.mdfor better discoverabilitydocs/index.mdCLAUDE.md Updates:
Repository Structure - Added new automation scripts section:
.github/scripts/codebase_agent/Python moduleDocumentation Structure - Updated to reflect current state:
docs/README.md- Quickstart guidedocs/patterns/- Standalone pattern docsdocs/adr/- ADR scaffoldingCI/CD Workflows - Now documents all 5 workflows:
codebase-agent.yml- Issue-to-PR and PR review automationdocs-validation.yml- Markdown linting and Mermaid validationci.yml- General CIdeploy-docs.yml- GitHub Pages deploymentsecurity.yml- Security scanningFiles Changed
Test Plan
🤖 Generated with Claude Code