docs: add comprehensive product and technical documentation#19
Open
docs: add comprehensive product and technical documentation#19
Conversation
Reorganize docs/ with a complete documentation structure covering product introduction, getting started guides (self-hosted, multi-tenant, unitae.app, development), hosting comparison and requirements, core concepts (display board, territories, publishers, roles, security), technical reference (coding conventions, environment variables), advanced guides (open data sync), and general guides (licensing, trademark, FAQ). Existing technical docs (architecture, background processing) are moved into the new technical-reference/ folder.
- Add dedicated core-concepts/events.md for programs, event kinds, and days off - Standardize role names to backticks in roles-and-permissions.md table - Add "Next Steps" section to unitae-app.md - Remove misleading leading dot from COOKIE_DOMAIN example - Link events doc from feature-overview.md and README.md index
Replace technical field names with the actual labels users see in the interface so non-technical readers can follow along more easily. - display-board: visibleFrom/visibleUntil → Visible à partir du/jusqu'au - territories: territory types, attribution fields, building prospection fields all use French UI labels - publishers: profile fields, publisher types, group roles, activity record fields all use French UI labels - events: event kind and program fields use French UI labels - roles-and-permissions: navigation path uses Réglages > Utilisateurs - feature-overview: aligned with all core-concepts changes
Rewrite README as a concise landing page that links to docs/ instead of duplicating deployment guides, env var tables, and project structure. Features now use French UI names. Slim CONTRIBUTING.md to contribution process only — setup steps and code conventions now link to docs/. Fix language rule: commits are English (was "French or English"). Remove stale pattern advice. Clean up SECURITY.md: remove Kubernetes/infrastructure details (internal to unitae.app), align reporting instructions with docs/security.md wording, add link to full security model in docs/.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/with 20 new files across 7 sectionsarchitecture-schema.md,background-processing-architecture.md) intodocs/technical-reference/Documentation structure
Test plan
docs/README.mdresolve to existing filesarchitecture-schema.md,background-processing-architecture.md) no longer exist at old paths