mirror of https://github.com/Stirling-Tools/Stirling-PDF.git synced 2026-09-03 05:10:16 +03:00

Files

T

Connor Yoh 5220f56726 feat(portal): shared Tooltip, key provenance, and the gaps the checkboxes exposed

Verifying the PR description against the code turned up several claims the
implementation did not meet.

- Tooltip moves into @app/ui. The editor tooltip needs the sidebar, preferences
  and app-config providers, none of which the portal mounts, so it cannot be
  reused there. The migration 'skipped' explanation now uses it instead of an
  inline paragraph.
- /status reports masterKeySource. The panel already branched on it, but the API
  never sent it, so the generated-key warning could not fire.
- The key table shows when a key changed, not just who, and explains RETIRED.
- The migration card shows when a run started.
- A 404 on a deleted key no longer advises retrying.
- Both runbook links now resolve, and the devGuide gained the backup section
  they point at.

2026-08-18 12:53:11 +01:00

DeveloperGuide.md

Add Taskfile for unified dev workflow across all components (#6080 )

2026-04-15 14:16:57 +00:00

EXCEPTION_HANDLING_GUIDE.md

Change default language to en-US and add US language (#6621 )

2026-06-11 20:36:23 +01:00

FILE_HISTORY_SPECIFICATION.md

Feature/v2/filehistory (#4370 )

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

HowToAddNewLanguage.md

Change default language to en-US and add US language (#6621 )

2026-06-11 20:36:23 +01:00

README.md

feat(storage): encryption-at-rest ops — audit, admin kill switch, migration, key rotation (PR2) (#7173 )

2026-08-11 12:01:58 +00:00

STORAGE_ENCRYPTION_AT_REST.md

feat(portal): shared Tooltip, key provenance, and the gaps the checkboxes exposed

2026-08-18 12:53:11 +01:00

STYLELINT.md

Clean up typos in docs, comments, and UI copy (#6045 )

2026-07-06 14:07:06 +00: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 (in repo root)
Taskfile.yml - Unified task runner for all build/dev/test/lint commands
EXCEPTION_HANDLING_GUIDE.md - Exception handling patterns and i18n best practices
HowToAddNewLanguage.md - Internationalization and translation guide
STORAGE_ENCRYPTION_AT_REST.md - Encryption at rest for stored files: key setup, migration, revocation, rotation

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