Repository navigation
Interactive roadmap explorer with generated PDF/PNG - #89
Merged
Merged
Conversation
Static site in site/ (vanilla ES modules, no build step) that reads README.md at runtime and draws the roadmap map. - Map view: Software, Software ∩ Hardware, Hardware and Soft skills areas, importance colors, area/importance filters, connections between topics, pan/zoom, A4 print stylesheet - Outline view, search and a details panel with descriptions and learning resources - site/map.json is the editable source of the map (bands, clusters, importance); layout.js places it on an A4 page with a minimum spacing - Credits with creator logo, CC BY-SA badge and build revision - Sofia Sans Semi Condensed bundled under the OFL - Tests for the README parser, map mapping and layout
site/tools/render.mjs serves the site, opens it in headless Chromium and writes an A4 PDF and a 2x PNG of the map using the print styles.
Run the tests, assemble the site with build revision info, render the PDF and PNG, deploy to GitHub Pages from master and attach the PDF and PNG to published releases.
The roadmap is now drawn by the explorer from README.md and site/map.json, so the .vsdx file and its lock-file ignores are no longer needed.
Point contributors to README.md and site/map.json as the sources of the roadmap and drop the remaining Visio references.
Shown only when the CI-rendered files exist next to the site; on phones they replace the Print button.
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.
Replaces the Visio diagram with an interactive explorer built from
README.mdandsite/map.json, deployed to GitHub Pages.site/tools/render.mjs), served next to the site and attached to published releasesmaster.vsdxfile; the map is edited insite/map.json