ADR-004 Add MkDocs Material Documentation Site#6
Merged
Conversation
jhagberg
force-pushed
the
adr/004-Mkdocs
branch
from
dfbba14 to
01e0787
Compare
jwindhager
requested changes
Dec 2, 2025
Member
jwindhager
left a comment
jwindhager
left a comment
There was a problem hiding this comment.
Cool! Some minor suggestions
(only reviewed files specific to ADR-004)
Closed
alneberg
reviewed
Dec 4, 2025
Member
|
Looks good! I agree with the comments by @jwindhager . |
jhagberg
force-pushed
the
adr/004-Mkdocs
branch
3 times, most recently
from
d3b2873 to
b9e1239
Compare
viklund
approved these changes
Dec 10, 2025
jhagberg
force-pushed
the
adr/004-Mkdocs
branch
from
02ace14 to
b9e1239
Compare
Netzach
approved these changes
Dec 10, 2025
…architecture governance description
…files - MkDocs Material theme with SciLifeLab visual identity - GitHub Actions workflow for automatic deployment - Homepage with mission, workflow diagram, and board members - Custom CSS for teal/lime branding - Cookie consent and Mermaid diagram support
Co-authored-by: Jonas Windhager <jonas@windhager.io>
…nding - Enhanced Mermaid diagrams with a unified theme for consistency across documentation. - Updated CSS for primary and secondary button styles to align with the new color scheme.
- Introduced a requirements.txt file to manage dependencies, specifically for mkdocs-material. - Updated the GitHub Actions workflow to install dependencies from requirements.txt instead of directly installing mkdocs-material.
…s formatting in deployment workflow
jhagberg
force-pushed
the
adr/004-Mkdocs
branch
from
b9e1239 to
6ea8902
Compare
… in Architecture Board contributions
alneberg
reviewed
Dec 11, 2025
Removed duplicate description of technical architecture governance.
jwindhager
reviewed
Dec 11, 2025
jwindhager
approved these changes
Dec 11, 2025
Member
jwindhager
left a comment
jwindhager
left a comment
There was a problem hiding this comment.
I guess we can address the remaining comments separately
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
6 participants
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.
Add MkDocs Material Documentation Site
This PR implements ADR-0004 by setting up a complete MkDocs Material documentation site with SciLifeLab visual identity.
What's Included
Documentation Site (
mkdocs.yml)Visual Identity (
docs/stylesheets/extra.css)Homepage (
docs/index.md)Assets
GitHub Actions (
.github/workflows/deploy-docs.yml)mkdocs gh-deployfor publishingPreview
Run locally with:
or check https://scilifelab.github.io/architecture/
Checklist
GitHub Pages Deployment
The GitHub Action uses
mkdocs gh-deploywhich builds the site and pushes to thegh-pagesbranch.Settings: Keep GitHub Pages configured to "Deploy from branch:
gh-pages" (no change needed).After merging: Any push to
mainwill automatically trigger the workflow, rebuild the site, and update thegh-pagesbranch.Site URL: https://scilifelab.github.io/architecture/