feat: Docs/unify quarto website#26
Merged
Merged
Conversation
quartify's rtoqmd_dir() has no way to include README/architecture/ADR
pages, and the previous docs-build call used a nonexistent `render`
argument (real name render_html) that silently no-opped, so the
generated reference was never actually part of a real site.
Demote quartify to a flat .qmd emitter (create_book = FALSE,
render_html = FALSE), relocate its output into docs/reference/, and
hand-author docs/_quarto.yml as the website project that ties
together the README (via {{< include >}} as the home page),
architecture/ADR markdown (rendered natively), and the generated
reference into one navigable site. Also fixes ~20 repo-relative
README links that would 404 once transcluded into docs/index.qmd,
plus several unrelated stale/broken links and content found along
the way (wrong test dir path, uv.lock vs rv.lock, wrong clone URL,
hello.py vs hello.r, stale Common Tasks table).
Also bumps jarl-pre-commit 0.4.0 -> 0.5.0: 0.4.0 fails to parse a
bare .qmd file with no frontmatter/R chunks (like docs/index.qmd's
{{< include >}}-only content) with "Failed to parse ... due to
syntax errors" — fixed upstream in 0.5.0, confirmed locally.
Verified locally: `quarto render docs/` renders all 10 pages
(README, architecture/ADRs, reference stubs) cleanly with working
absolute links. quartify itself couldn't be exercised locally due to
a pre-existing R 4.6.1/rv-pinned-4.5 mismatch on this machine
(unrelated to this change, CI pins R 4.5 via setup-r so unaffected);
the create_book/render_html argument behavior was confirmed by
reading quartify's installed source directly.
Documented as ADR-004 (Accepted — no tagged release exists yet, so
this is a clean initial decision, not a reversal of anything shipped).
Assisted-by: Claude Sonnet 5 <noreply@anthropic.com>
__init__.r in a box module is just re-export wiring (box::use(...)), not a documented module — its converted qmd is normally empty of real content. Exclude it in docs-build before relocating quartify's output, and drop the corresponding "Package overview" nav entry. Assisted-by: Claude Sonnet 5 <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.
What changes did you make (give an overview)?
Quarto website for all documentation content in the project
Prerequisites checklist
Please check each of the following before merging:
What is the purpose of this pull request?
Check all that apply: