Commit graph

2 commits

Author SHA1 Message Date
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
3f405d3ec6 docs: add security quick reference guide
- Add SECURITY_QUICKREF.md for easy reference
- Cover all security features with examples
- Include 4 security levels (default to maximum)
- Document environment variables with examples
- Provide troubleshooting guide
- Include production deployment examples
- Add migration guide (backward compatible)
- Performance impact analysis

Quick reference for:
- Configuration options
- Security levels
- Rate limiting behavior
- Connection limits
- Key management
- Testing procedures
- Production best practices
2026-01-22 14:35:00 +08:00