Skip to content

Commit cc7cf7c

Browse files
jzhuclaude
andcommitted
docs: reorganize all markdown files into docs folder
- Moved CLAUDE.md → docs/CLAUDE.md (AI-assisted edit guidelines) - Moved CONTRIBUTING.md → docs/CONTRIBUTING.md (contribution guidelines) - Moved INSTALL.md → docs/INSTALL.md (installation guide) - Moved README_zh.md → docs/README_zh.md (Chinese readme) - Updated README.md to reference files in docs/ folder Rationale: All documentation files except README.md are now in the docs/ folder for better organization and clarity. 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 5191590 commit cc7cf7c

4 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Key files and responsibilities
3232

3333
- README.md (this file): User-facing quick-start and developer deep analysis (this section).
3434

35-
- INSTALL.md: Detailed installation options and scripts.
35+
- docs/INSTALL.md: Detailed installation options and scripts.
3636

37-
- CLAUDE.md: Repository guidelines for AI-assisted edits. Important: follow these when creating AI-generated changes.
37+
- docs/CLAUDE.md: Repository guidelines for AI-assisted edits. Important: follow these when creating AI-generated changes.
3838

3939
- pytest.ini: Configures test discovery and pytest run options.
4040

@@ -53,7 +53,7 @@ Development workflow and testing
5353
- Recommended local development flow:
5454
1. Create a feature branch: feature/<desc> or fix/<desc>.
5555
2. Run linters and formatters (project uses Black/Flake8? not enforced in repo snapshot) and the full test suite.
56-
3. Make focused commits and open a PR with tests and a clear description. Include `Co-Authored-By: Claude <noreply@anthropic.com>` when AI-assisted edits were used (see CLAUDE.md).
56+
3. Make focused commits and open a PR with tests and a clear description. Include `Co-Authored-By: Claude <noreply@anthropic.com>` when AI-assisted edits were used (see docs/CLAUDE.md).
5757

5858
- Tests are fairly extensive and broken into unit, integration, and interactive categories under tests/.
5959

@@ -97,7 +97,7 @@ Areas for improvement and recommendations
9797

9898
5. Hardening: Add secrets scanning to CI and improve the heuristic used in the doctor security check (e.g., integrate detect-secrets or truffleHog).
9999

100-
6. Documentation: Add a CONTRIBUTING.md and CODE_OF_CONDUCT.md to standardize PR process and contributor expectations (though CLAUDE.md provides AI-specific guidance).
100+
6. Documentation: docs/CONTRIBUTING.md and CODE_OF_CONDUCT.md to standardize PR process and contributor expectations (though docs/CLAUDE.md provides AI-specific guidance).
101101

102102
7. Release automation: Add a release workflow for pushing to PyPI and draft GitHub releases; ensure version bumping is automated (bump2version or similar).
103103

File renamed without changes.
File renamed without changes.

INSTALL.md renamed to docs/INSTALL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,4 +386,4 @@ After successful installation:
386386
4. **Explore Features**: Try `code-assistant-manager --help` to see all options
387387

388388
For detailed configuration instructions, see the main [README.md](README.md) file.</content>
389-
<parameter name="file_path">INSTALL.md
389+
<parameter name="file_path">INSTALL.md

0 commit comments

Comments
 (0)