Roadmap

Ouverte
  • Quelque chose ne va pas ?
#16 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

@VisruthSK y travaille déjà.

Depuis le 9/10/2026.

  • #18 par @VisruthSK — ouverte

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
markdown, r, yaml
Domaine
documentation

Piste de recherche

Start with the _pkgdown.yml roadmap configuration described in the issue and compare the linked stan-dev/loo pull request 396. Trace how this pkg currently handles website templates and how an Rmd document could be integrated without emitting HTML. Done means an opt-in roadmap supports milestone and issue overrides, exclusions, ordering, and closed-issue marking.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Add a roadmap template like @florence-bockting did for loo: https://github.com/stan-dev/loo/pull/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:

roadmap:
  enabled: true

Of course, they would have to use milestones/labels as well, but the website part would be handled by this pkg.

Langage dominant
HTML
Étoiles
0
Forks
0
Merge moyen
35 min
PR mergées (30 j)
3

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de stan-dev/pkgdown-config

Toutes les issues de stan-dev/pkgdown-config

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.