Skip to content

Roadmap Page - #18

Draft
VisruthSK wants to merge 30 commits into
v3.0from
roadmap
Draft

VisruthSK wants to merge 30 commits into
v3.0from
roadmap

Conversation

@VisruthSK

@VisruthSK VisruthSK commented Oct 9, 2026 •

Copy link
Copy Markdown
Member

@VisruthSK VisruthSK added the build-website Build the website automatically label Oct 9, 2026
GitHub Actions does not follow symlinks for workflow files and parsed the
link target as YAML, so the workflow was invalid.
Silence gh progress output leaking into the roadmap page, restyle the cards
to follow the theme, drop KaTeX, update MathJax to 4.1.3 and fix the
malformed SVG favicon link.
Hide the roadmap article from the Articles index by listing it in an
internal section, and set the navbar and sections on the parsed package
instead of through the override. Add the roadmap issue description to
this site's config.
@VisruthSK
VisruthSK changed the base branch from main to v3.0 October 10, 2026 20:27
roadmap_site() now writes the roadmap markdown into the article, so pkgdown
renders plain Markdown and no R code runs during the render. The article
is written as .Rmd by default, or .qmd with `roadmap: format: qmd`.

Only build_site() and use_pkgdown_gha() are exported. The GitHub Action
calls roadmap_site() through `:::`. The roadmap article is hidden from the
Articles index and linked from the navbar. Imports now includes pkgdown
instead of Depends.

Issue titles from GitHub pass through as Markdown, so backticks still
render as code.
build_gha_site() prepares the roadmap and builds the site for GitHub Pages,
including the pull request preview overrides. The workflow calls it in one
line. gha_override() builds the PR overrides and is tested directly.
roadmap_markdown() returns the markdown, so the name says what it does. Add
fixture tests for filtering, ordering and overrides with GitHub mocked, and
an end-to-end build of a site with its own articles section.
Writing the article no longer deletes an existing roadmap file in the other
format. It stops with an error instead, so the choice stays with the user.
Inline the helpers that had a single caller, drop the version comparison in
favour of plain labels, and return only for a 404 when reading the latest
release. Classes are joined with a plain space. roadmap() is now
roadmap_markdown(). Add tests for the release errors, the overrides of
build_gha_site(), and a Quarto build.
Milestones with no open issues were dropped silently. The build now warns
and continues. The logo fallback note moves to the v3.0 Setup vignette.
# Conflicts:
#	inst/pkgdown/templates/head.html
#	inst/workflows/pkgdown.yaml
#	tests/testthat.R
#	tests/testthat/test-workflow.R
#	vignettes/Setup.qmd
This reverts commit 93fa665.
… link

build_gha_site() forwards ... to pkgdown::build_site_github_pages(), with
run_dont_run = TRUE as the default. It also writes PREVIEW_URL for the sticky
PR comment, which the workflow posts with the commit SHA.
@github-actions

Copy link
Copy Markdown
Contributor

Preview: https://mc-stan.org/pkgdown-config/pr/18
Built from 5930bd5

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build-website Build the website automatically

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Roadmap

1 participant