You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,9 +32,9 @@ Key files and responsibilities
32
32
33
33
- README.md (this file): User-facing quick-start and developer deep analysis (this section).
34
34
35
-
- INSTALL.md: Detailed installation options and scripts.
35
+
-docs/INSTALL.md: Detailed installation options and scripts.
36
36
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.
38
38
39
39
- pytest.ini: Configures test discovery and pytest run options.
40
40
@@ -53,7 +53,7 @@ Development workflow and testing
53
53
- Recommended local development flow:
54
54
1. Create a feature branch: feature/<desc> or fix/<desc>.
55
55
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).
57
57
58
58
- Tests are fairly extensive and broken into unit, integration, and interactive categories under tests/.
59
59
@@ -97,7 +97,7 @@ Areas for improvement and recommendations
97
97
98
98
5. Hardening: Add secrets scanning to CI and improve the heuristic used in the doctor security check (e.g., integrate detect-secrets or truffleHog).
99
99
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).
101
101
102
102
7. Release automation: Add a release workflow for pushing to PyPI and draft GitHub releases; ensure version bumping is automated (bump2version or similar).
0 commit comments