docs: clarify vocabulary page generation pipeline#136
Merged
rdhyee merged 1 commit intoisamplesorg:mainfrom Apr 24, 2026
Merged
docs: clarify vocabulary page generation pipeline#136rdhyee merged 1 commit intoisamplesorg:mainfrom
rdhyee merged 1 commit intoisamplesorg:mainfrom
Conversation
Rewrites the Development section's vocab paragraph to describe the actual two-stage build: 1. TTL → markdown via the `vocab` CLI from isamplesorg/vocab_tools (installed via pipx in CI), driven by scripts/generate_vocab_docs.sh 2. markdown → HTML via `quarto render` applying _quarto.yml's theme, nav, and sidebar Also notes that scripts/vocab2md.py is no longer invoked (PR isamplesorg#48 switched to the `vocab markdown` CLI entry point — same tool, same transform) to prevent future confusion about which code produces the rendered vocabulary pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Rewrites the Development section of the README to accurately describe the two-stage vocabulary page build:
vocabCLI from isamplesorg/vocab_tools (installed via pipx in CI), driven byscripts/generate_vocab_docs.sh.quarto renderapplying_quarto.yml's theme, navigation, and sidebar.Also notes that
scripts/vocab2md.pyis no longer part of the build — PR #48 switched to thevocab markdownCLI entry point (same tool, same transform). The existing README paragraph still pointed atvocab2md.py, which caused confusion about which code produces the rendered vocabulary pages.No functional changes; documentation only.
Test plan
.github/workflows/quarto-pages.ymlandscripts/generate_vocab_docs.sh🤖 Generated with Claude Code