Skip to content

docs: publish architecture documentation via mdBook and GitHub Pages (closes #28) - #29

Open
Dani-giron wants to merge 2 commits into
reverseame:apotheosis2from
Dani-giron:j1-docs-mdbook
Open

docs: publish architecture documentation via mdBook and GitHub Pages (closes #28)#29
Dani-giron wants to merge 2 commits into
reverseame:apotheosis2from
Dani-giron:j1-docs-mdbook

Conversation

@Dani-giron

Copy link
Copy Markdown

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 to apotheosis2.

No content was moved or restructured to fit mdBook; book.toml points src directly at the existing architecture/ folder, and SUMMARY.md just lists the documents that were already there.

Included in this PR, see #28 for details on each:

After 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 apotheosis2 branch to deploy under the github-pages environment'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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant