|
|
da8b77d625
|
docs: reorganize documentation structure
- Move all documentation to docs/ directory for better organization
- Rewrite README.md following Linux kernel style (English only)
- Rename HACKING -> CONTRIBUTING.md
- Rename QUICKREF -> QUICKREF.md
- Rename README -> README.old
- Add comprehensive Development-Guide.md for contributors
Documentation structure:
- README.md: Project overview and quick start
- docs/Development-Guide.md: Complete developer manual
- docs/CONTRIBUTING.md: Contribution guidelines
- docs/DEPLOYMENT.md: Production deployment guide
- docs/SECURITY_QUICKREF.md: Security config reference
- docs/QUICKREF.md: Command cheat sheet
This aligns with Linux kernel documentation practices:
simple, organized, and accessible.
|
2026-02-07 23:31:53 +08:00 |
|
|
|
5c11fb1b04
|
Add developer documentation
New files:
- HACKING - Architecture, debugging, common pitfalls
- QUICKREF - One-page reference card
- Updated CHANGELOG.md with recent fixes
- Updated README.md with development section
HACKING covers:
- Build system
- Test procedures
- Memory debugging (asan, valgrind)
- Thread safety rules
- Architecture overview
- Known limits
- Common bugs to avoid
- Feature addition guide
QUICKREF provides:
- Quick build commands
- Test commands
- Debug procedures
- File structure
- System limits
Follows minimalist Unix documentation philosophy.
No fluff, just facts.
|
2025-12-02 15:00:00 +08:00 |
|
