Documentation - #6
Closed
jravani wants to merge 2 commits into
Closed
Conversation
Adds the arc42 LaTeX documentation (Runtime View and Deployment View with draw.io diagrams, Architectural Decisions, Crosscutting Concepts) covering the reverse-proxy + containerized deployment work. Adds an OpenAPI 3.0.3 spec rendered as interactive Swagger UI in MkDocs, with generic (non-platform-specific) authentication guidance and a local testing walkthrough. Removes the low-value pipeline.md page and trims MkDocs to Home, Getting started, API reference, and Validation.
Adds a build-arc42 job that compiles documentation/main.tex inside the full TeX Live container, then wires the resulting PDF into the same gh-pages deploy as the MkDocs site (documentation.pdf), replacing mkdocs gh-deploy with an explicit build + peaceiris/actions-gh-pages step so both can land in the same publish. Links it from docs/index.md so it's actually reachable, not just deployed.
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.
No description provided.