mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2026-03-19 02:22:11 +01:00
32cf6866f3
# Description of Changes Inspired by https://github.com/pydantic/pydantic-ai/pull/4169, this PR moves our `CLAUDE.md` advice to the more generic `AGENTS.md` file (which works on Codex, Gemini, etc). It also adds a symlink from `CLAUDE.md` to `AGENTS.md`, which Claude follows properly, so all AIs should get the same advice and we only need to keep one file up-to-date.
Developer Guide Directory
This directory contains all development-related documentation for Stirling PDF.
📚 Documentation Index
Core Development
- DeveloperGuide.md - Main developer setup and architecture guide
- EXCEPTION_HANDLING_GUIDE.md - Exception handling patterns and i18n best practices
- HowToAddNewLanguage.md - Internationalization and translation guide
Features & Documentation
- AGENTS.md - Agent-based functionality documentation
- USERS.md - User-focused documentation and guides
🔗 Related Files in Root
- README.md - Project overview and quick start
- CONTRIBUTING.md - Contribution guidelines
- SECURITY.md - Security policies and reporting
- DATABASE.md - Database setup and configuration (usage guide)
- HowToUseOCR.md - OCR setup and configuration (usage guide)
📝 Contributing to Documentation
When adding new development documentation:
- Place technical guides in this
devGuide/directory - Update this index file with a brief description
- Keep user-facing docs (README, CONTRIBUTING, SECURITY) in the root
- Follow existing naming conventions (PascalCase for guides)