mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2025-10-25 11:17:28 +02:00
eb7f5e57cc
# Description of Changes - **What was changed** - Updated `.github/labeler-config-srvaroa.yml` to match the new `devGuide/.*` patterns instead of the old `HowToAddNewLanguage.md` - Modified `.github/pull_request_template.md` to point to `devGuide/DeveloperGuide.md` and `devGuide/HowToAddNewLanguage.md` for the Developer Guide and translation-tags sections - Updated the SSO link in `README.md` to point to the 'Single Sign-On Configuration' section on docs.stirlingpdf.com instead of the outdated Enterprise Edition page - Changed the relative link in `devGuide/DeveloperGuide.md` to use `../CONTRIBUTING.md` for consistency - Added a new `devGuide/EXCEPTION_HANDLING_GUIDE.md` to document standard exception-handling patterns and internationalisation best practices - Updated `devGuide/README.md` index to reflect the new location and naming conventions for development guides - **Why the change was made** - To centralise all development documentation under a single `devGuide` directory for better organisation and discoverability. - To ensure that GitHub labeler rules and PR templates correctly reference the new file structure. - To introduce a clear, project-wide guide on exception handling, improving consistency across Java, JavaScript, HTML/CSS, and Python components. Closes #3799 --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
# Developer Guide Directory
|
|
|
|
This directory contains all development-related documentation for Stirling PDF.
|
|
|
|
## 📚 Documentation Index
|
|
|
|
### Core Development
|
|
- **[DeveloperGuide.md](./DeveloperGuide.md)** - Main developer setup and architecture guide
|
|
- **[EXCEPTION_HANDLING_GUIDE.md](./EXCEPTION_HANDLING_GUIDE.md)** - Exception handling patterns and i18n best practices
|
|
- **[HowToAddNewLanguage.md](./HowToAddNewLanguage.md)** - Internationalization and translation guide
|
|
|
|
### Features & Documentation
|
|
- **[AGENTS.md](./AGENTS.md)** - Agent-based functionality documentation
|
|
- **[USERS.md](./USERS.md)** - User-focused documentation and guides
|
|
|
|
## 🔗 Related Files in Root
|
|
- **[README.md](../README.md)** - Project overview and quick start
|
|
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - Contribution guidelines
|
|
- **[SECURITY.md](../SECURITY.md)** - Security policies and reporting
|
|
- **[DATABASE.md](../DATABASE.md)** - Database setup and configuration (usage guide)
|
|
- **[HowToUseOCR.md](../HowToUseOCR.md)** - OCR setup and configuration (usage guide)
|
|
|
|
## 📝 Contributing to Documentation
|
|
|
|
When adding new development documentation:
|
|
1. Place technical guides in this `devGuide/` directory
|
|
2. Update this index file with a brief description
|
|
3. Keep user-facing docs (README, CONTRIBUTING, SECURITY) in the root
|
|
4. Follow existing naming conventions (PascalCase for guides)
|