arsvendg/Stirling-PDF

Fork 0

mirror of https://github.com/arsvendg/Stirling-PDF.git synced 2026-07-14 10:34:06 +02:00

Files

T

History

+18

68ed54e398 V1 merge (#5193 )

# Description of Changes

<!--
Please provide a summary of the changes, including:

- What was changed
- Why the change was made
- Any challenges encountered

Closes #(issue_number)
-->

---

## Checklist

### 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/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/devGuide/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/devGuide/DeveloperGuide.md#6-testing)
for more details.

---------

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Balázs Szücs <[email protected]>
Signed-off-by: stirlingbot[bot] <stirlingbot[bot]@users.noreply.github.com>
Co-authored-by: ConnorYoh <[email protected]>
Co-authored-by: Connor Yoh <[email protected]>
Co-authored-by: OUNZAR Aymane <[email protected]>
Co-authored-by: YAOU Reda <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: stirlingbot[bot] <195170888+stirlingbot[bot]@users.noreply.github.com>
Co-authored-by: Balázs Szücs <[email protected]>
Co-authored-by: Ludy <[email protected]>
Co-authored-by: tkymmm <[email protected]>
Co-authored-by: Peter Dave Hello <[email protected]>
Co-authored-by: albanobattistella <[email protected]>
Co-authored-by: PingLin8888 <[email protected]>
Co-authored-by: FdaSilvaYY <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: OteJlo <[email protected]>
Co-authored-by: Angel <[email protected]>
Co-authored-by: Ricardo Catarino <[email protected]>
Co-authored-by: Luis Antonio Argüelles González <[email protected]>
Co-authored-by: Dawid Urbański <[email protected]>
Co-authored-by: Stephan Paternotte <[email protected]>
Co-authored-by: Leonardo Santos Paulucio <[email protected]>
Co-authored-by: hamza khalem <[email protected]>
Co-authored-by: IT Creativity + Art Team <[email protected]>
Co-authored-by: Reece Browne <[email protected]>
Co-authored-by: James Brunton <[email protected]>
Co-authored-by: Victor Villarreal <[email protected]>

2025-12-21 10:40:32 +00:00

AGENTS.md

exception handling and exception improvements (#3858 )

2025-07-02 16:51:45 +01:00

DeveloperGuide.md

V1 merge (#5193 )

2025-12-21 10:40:32 +00: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

FILE_HISTORY_SPECIFICATION.md

Feature/v2/filehistory (#4370 )

2025-09-16 15:08:11 +01:00

HowToAddNewLanguage.md

Toml (#5115 )

2025-12-03 09:57:00 +00: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

exception handling and exception improvements (#3858 )

2025-07-02 16:51:45 +01:00

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)

README.md

Developer Guide Directory

📚 Documentation Index

Core Development

Features & Documentation

🔗 Related Files in Root

📝 Contributing to Documentation