Mirrors/Stirling-PDF

mirror of https://github.com/Frooodle/Stirling-PDF.git synced 2025-09-03 17:52:30 +02:00

History

Anthony Stirling 57cf5d4812 gradle path to /app		2025-07-15 15:40:56 +01:00
..
AGENTS.md	gradle path to /app	2025-07-15 15:40:56 +01:00
DeveloperGuide.md	gradle path to /app	2025-07-15 15:40:56 +01:00
EXCEPTION_HANDLING_GUIDE.md	docs: restructure documentation paths, update PR template links, and add exception handling guide (#3885 )	2025-07-07 09:49:44 +01:00
HowToAddNewLanguage.md	refactor: move modules under app/ directory and update file paths (#3938 )	2025-07-14 20:53:11 +01:00
README.md	docs: restructure documentation paths, update PR template links, and add exception handling guide (#3885 )	2025-07-07 09:49:44 +01:00
STYLELINT.md	refactor: move modules under app/ directory and update file paths (#3938 )	2025-07-14 20:53:11 +01:00
USERS.md

README.md

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

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)