Migrate the markdown documentation to MDBook - #1
Open
beastr45 wants to merge 4 commits into
Open
Conversation
Replaces the hand-rolled client-side markdown renderer with mdBook: build-time CommonMark parsing, SUMMARY.md as an explicit manifest (replaces implicit page_N.md numbering), plain relative markdown links between chapters (replaces the page_N.md -> #page_N hash rewrite hack), and the shared visual theme pulled in as a git submodule instead of a locally-duplicated copy of app.js/style.css.
update the submodules to point to a public repo and not a file on my computer.
This workflow builds and deploys an mdBook site to GitHub Pages on pushes to the main branch. remove old deploy script
fix foreal
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.
Hey Avi can you review how the docs in this commit look? Here is the github pages output: https://beastr45.github.io/analog-tutorials/welcome.html
I migrated the documentation of the analog tutorials to MDBook as a test run so I havent migrated the digital tutorials docs. I think that mdbook is way easier to use plus is more mature and stable compared to the claude formatting code. All you have to do is update SUMMARY.md to add new chapters and the rest is automatic.
Now the book content and html and theming are fully decoupled, there is no html or web source code in this repo anymore. Before we migrate the docs to we will want need make a submodule on the ASIC network github used for storing site wide docs theming. I don't have access to make that however. Updating the theming will no longer require commits in each documentation repo.
I didn't really mess around too much with the css styling, just enough to acheive visual parity with the website because the mdbook defaults are pretty good. May want to ask claude to fix a few things in the theme repo though.