Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrating documentation to Github Pages #217

Merged
merged 15 commits into from
Apr 20, 2022
Merged

Migrating documentation to Github Pages #217

merged 15 commits into from
Apr 20, 2022

Conversation

ryan-summers
Copy link
Member

@ryan-summers ryan-summers commented Apr 20, 2022

This PR fixes #204 by migrating Booster documentation to a Github Pages-based site.

Docs can be found at https://quartiq.de/booster-doc/overview.html

TODO:

  • Configure Github Pages for publishing
  • Test publishing workflow

book/src/overview.md Outdated Show resolved Hide resolved
book/src/front-panel.md Outdated Show resolved Hide resolved
book/src/front-panel.md Outdated Show resolved Hide resolved
book/src/firmware-update.md Outdated Show resolved Hide resolved
@ryan-summers ryan-summers requested a review from jordens April 20, 2022 14:13
Copy link
Member

@jordens jordens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple more places of consistent terminology use. Otherwise good to go.

book/src/front-panel.md Outdated Show resolved Hide resolved
book/src/front-panel.md Outdated Show resolved Hide resolved
book/src/front-panel.md Outdated Show resolved Hide resolved
book/src/front-panel.md Outdated Show resolved Hide resolved
book/src/network-interface.md Outdated Show resolved Hide resolved
book/src/network-interface.md Outdated Show resolved Hide resolved
@ryan-summers ryan-summers requested a review from jordens April 20, 2022 14:52
@jordens jordens merged commit 79307c0 into develop Apr 20, 2022
@jordens jordens deleted the feature/mdbook branch April 20, 2022 15:18
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.

Migrate documentation to cargo-book + Github Pages
2 participants