links

.github/labeler-config-srvaroa.yml

@@ -115,7 +115,7 @@ labels:
       - '.editorconfig'
       - '.pre-commit-config'
       - '.github/workflows/pre_commit.yml'
-      - 'HowToAddNewLanguage.md'
+      - 'devGuide/.*'
 
   - label: 'Test'
     files:

.github/pull_request_template.md

@@ -15,15 +15,15 @@ Closes #(issue_number)
 ### General
 
 - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
-- [ ] 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)
+- [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/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/devGuide/HowToAddNewLanguage.md) (if applicable)
 - [ ] I have performed a self-review of my own code
 - [ ] 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)
+- [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only)
 
 ### UI Changes (if applicable)
 
@@ -31,4 +31,4 @@ Closes #(issue_number)
 
 ### 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.
+- [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.

README.md

@@ -29,7 +29,7 @@ All documentation available at [https://docs.stirlingpdf.com/](https://docs.stir
 - API for integration with external scripts
 - Optional Login and Authentication support (see [here](https://docs.stirlingpdf.com/Advanced%20Configuration/System%20and%20Security) for documentation)
 - Database Backup and Import (see [here](https://docs.stirlingpdf.com/Advanced%20Configuration/DATABASE) for documentation)
-- Enterprise features like SSO see [here](https://docs.stirlingpdf.com/Enterprise%20Edition)
+- Enterprise features like SSO (see [here](https://docs.stirlingpdf.com/Advanced%20Configuration/Single%20Sign-On%20Configuration) for documentation)
 
 ## PDF Features
 

devGuide/DeveloperGuide.md

@@ -272,7 +272,7 @@ Important notes:
 
 6. Push your changes to your fork.
 7. Submit a pull request to the main repository.
-8. See additional [contributing guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md).
+8. See additional [contributing guidelines](../CONTRIBUTING.md).
 
 When you raise a PR:
 

devGuide/EXCEPTION_HANDLING_GUIDE.md

@@ -0,0 +1,66 @@
+# Exception Handling Guide
+
+This guide outlines the common error handling patterns used within Stirling-PDF and provides tips for internationalising error messages. The examples cover the main languages found in the project: Java, JavaScript, HTML/CSS, and a small amount of Python.
+
+## General Principles
+
+- **Fail fast and log clearly.** Exceptions should provide enough information for debugging without exposing sensitive data.
+- **Use consistent user messages.** Text shown to users must be pulled from the localisation files so that translations are centrally managed.
+- **Avoid silent failures.** Always log unexpected errors and provide the user with a helpful message.
+
+## Java
+
+Java forms the core of Stirling-PDF. When adding new features or handling errors:
+
+1. **Create custom exceptions** to represent specific failure cases. This keeps the code self-documenting and easier to handle at higher levels.
+2. **Use `try-with-resources`** when working with streams or other closable resources to ensure clean-up even on failure.
+3. **Return meaningful HTTP status codes** in controllers by throwing `ResponseStatusException` or using `@ExceptionHandler` methods.
+4. **Log with context** using the project’s logging framework. Include identifiers or IDs that help trace the issue.
+5. **Internationalise messages** by placing user-facing text in `messages_en_GB.properties` and referencing them with message keys.
+
+## JavaScript
+
+On the client side, JavaScript handles form validation and user interactions.
+
+- Use `try`/`catch` around asynchronous operations (e.g., `fetch`) and display a translated error notice if the call fails.
+- Validate input before sending it to the server and provide inline feedback with messages from the translation files.
+- Log unexpected errors to the browser console for easier debugging, but avoid revealing sensitive information.
+
+## HTML & CSS
+
+HTML templates should reserve a space for displaying error messages. Example pattern:
+
+```html
+<div class="error" role="alert" th:text="${errorMessage}"></div>
+```
+
+Use CSS classes (e.g., `.error`) to style the message so it is clearly visible and accessible. Keep the markup simple to ensure screen readers can announce the error correctly.
+
+## Python
+
+Python scripts in this project are mainly for utility tasks. Follow these guidelines:
+
+- Wrap file operations or external calls in `try`/`except` blocks.
+- Print or log errors in a consistent format. If the script outputs messages to end users, ensure they are translatable.
+
+Example:
+
+```python
+try:
+  perform_task()
+except Exception as err:
+  logger.error("Task failed: %s", err)
+  print(gettext("task.error"))
+```
+
+## Internationalisation (i18n)
+
+All user-visible error strings should be defined in the main translation file (`messages_en_GB.properties`). Other language files will use the same keys. Refer to messages in code rather than hard-coding text.
+
+When creating new messages:
+
+1. Add the English phrase to `messages_en_GB.properties`.
+2. Reference the message key in your Java, JavaScript, or Python code.
+3. Update other localisation files as needed.
+
+Following these patterns helps keep Stirling-PDF stable, easier to debug, and friendly to users in all supported languages.

devGuide/README.md

@@ -26,4 +26,4 @@ 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)
+4. Follow existing naming conventions (PascalCase for guides)