Add reference documentation suite - #12
Merged
Merged
Conversation
Add docs/ reference set (architecture, configuration, operations runbook, security model, API reference) with a docs index, plus a CONTRIBUTING guide and a CHANGELOG. Link the docs from the README.
A project build report (scope, time, cost, and a delivery comparison), rendered to PDF and kept under docs/reports/ for reference.
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.
Adds a full reference documentation set so the project is approachable without reading the source.
docs/
ARCHITECTURE.md— components, request flows, data model, host integrationCONFIGURATION.md— every environment variable, default, and effectOPERATIONS.md— first deploy, Authentik/Caddy wiring, day-two runbookSECURITY.md— auth model, abuse controls, fingerprinting, threat modelAPI.md— every HTTP route, auth tier, parameters, responsesREADME.md— docs indexTop level
CONTRIBUTING.md— setup, workflow, test requirements, conventionsCHANGELOG.md— change historyAlso adds a project build report under
docs/reports/(scope, time, and a delivery comparison).Docs-only change; no application code touched.