docs: add-ons Overview section + upstream attribution - #4
Merged
Conversation
Add an end-user Overview chapter (Getting Started -> Overview -> User Guide) mapping every add-on in the distribution by purpose, with a Python-generated, brand-coloured SVG (docs/assets/diagrams/addons.svg) and a fully linked table (docs/overview/addons.md). Both are rendered from lib/addons.json by lib/gen-addons-docs.py (nix run .#handbook-addons) and DRIFT-CHECKED against the live config/ tree, so the docs cannot fall out of step with the architecture. Wired into the mkdocs nav, the PDF chapter order, and the docs + release CI. Also credit the upstream Schrovimger project by Rahul Tudu (jack-thesparrow), which timvim was forked from, and the NVF framework, across the README (now a single canonical file mirrored to .github/README.md) and the handbook.
|
📄 Handbook PDF for this PR ( Download it from the workflow artifacts (short-lived, 7 days). The site preview publishes to GitHub Pages once this merges to 📦 Software Bill of Materials543 components for timvim-wrapped (runtime closure).
Full CycloneDX + SPDX SBOMs are attached as build artefacts. Download the full CycloneDX + SPDX SBOM (short-lived, 7 days). |
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.
Summary
Adds an end-user Overview chapter to the handbook (Getting Started ->
Overview -> User Guide) that maps every add-on in the timvim distribution by
purpose, and properly credits the upstream project timvim was forked from.
Overview section
docs/assets/diagrams/addons.svg, a Python-generated,brand-coloured (kartozaColors) map of all add-ons grouped into families.
docs/overview/addons.md, every add-on with a one-line purpose,On/Off default and a link to its upstream project.
lib/addons.json; rendered bylib/gen-addons-docs.py(nix run .#handbook-addons), whichdrift-checks the manifest against the live
config/tree: add or removea plugin without documenting it and the build fails.
lib/docs-pdf.sh) and thedocs + release CI.
Attribution
project by Rahul Tudu (jack-thesparrow) — the fork timvim is built on — and
the NVF framework, in the README and
the handbook.
README.mdis now the single canonical README, mirrored into.github/README.md.Testing
python3 lib/gen-addons-docs.py .renders both artefacts and the drift checkpasses; a negative test (an undocumented plugin) correctly fails the build.
nixfmtclean onflake.nix.nix run .#handbook-build(strict) locally before merge — thesandbox has
nix-commanddisabled.Fixes #3