Add a roadmap template like @florence-bockting did for loo: stan-dev/loo#396
This pkg should read a roadmap section in _pkgdown.yml and support overrides per issue for custom descriptions, same for milestones.
Internally the cleanest way of doing this might be to build a custom Rmd which is styled automatically and to wire in some custom classes as needed from Florence's PR. That way actual rendering is purely pkgdown's purview. That is, this pkg shouldn't emit HTML.
Example template:
roadmap:
enabled: true
format: "rmd" # in the future support writing a "qmd"
overrides:
milestones:
# milestone numbers, not their titles, for stable IDs.
"1":
title: "Version 3.0"
description: >
Custom release-level prose.
issues:
# similarly, issue numbers for stable ID
"123":
description: >
Custom issue-level prose.
exclude:
labels:
- "internal*"
- "wontfix"
- "invalid"
issues:
- "124"
- "456"This would require pkgs to opt-in, would exclude all PRs, exclude closed milestones, and exclude issues with those labels. Closed issues (which aren't filtered out) in an open milestone should be marked and maybe moved to the end, but otherwise included. Issues will be ordered by issue number.
This would be the default, defined in this pkg, and downstream pkgs could, of course, override as needed. All a typical Stan package would need to get the roadmap is:
Of course, they would have to use milestones/labels as well, but the website part would be handled by this pkg.
Add a roadmap template like @florence-bockting did for
loo: stan-dev/loo#396This pkg should read a roadmap section in
_pkgdown.ymland support overrides per issue for custom descriptions, same for milestones.Internally the cleanest way of doing this might be to build a custom Rmd which is styled automatically and to wire in some custom classes as needed from Florence's PR. That way actual rendering is purely pkgdown's purview. That is, this pkg shouldn't emit HTML.
Example template:
This would require pkgs to opt-in, would exclude all PRs, exclude closed milestones, and exclude issues with those labels. Closed issues (which aren't filtered out) in an open milestone should be marked and maybe moved to the end, but otherwise included. Issues will be ordered by issue number.
This would be the default, defined in this pkg, and downstream pkgs could, of course, override as needed. All a typical Stan package would need to get the roadmap is:
Of course, they would have to use milestones/labels as well, but the website part would be handled by this pkg.