docs: publish architecture documentation via mdBook and GitHub Pages (closes #28) - #29
Open
Dani-giron wants to merge 2 commits into
Open
docs: publish architecture documentation via mdBook and GitHub Pages (closes #28)#29Dani-giron wants to merge 2 commits into
Dani-giron wants to merge 2 commits into
Conversation
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
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.
Closes #28.
Sets up mdBook over the existing
docs/architecture/Views and Beyond documentation and adds a GitHub Actions workflow that deploys it to GitHub Pages on push toapotheosis2.No content was moved or restructured to fit mdBook;
book.tomlpointssrcdirectly at the existingarchitecture/folder, andSUMMARY.mdjust lists the documents that were already there.Included in this PR, see #28 for details on each:
mdbook-mermaid install).gitkeepremovedAfter merging, two one-time repository settings are needed for the site to go live: enable Pages with source set to GitHub Actions, and allow the
apotheosis2branch to deploy under thegithub-pagesenvironment's protection rules.What to do with the existing valhalla.unizar.es mirror is intentionally out of scope here; that involves university infrastructure outside this repo and will be proposed separately once Pages is confirmed working.