A collection of smaller documentation structure improvements raised during package review.
Items
- LICENSE stub NOTE — fill in ORGANIZATION field
- Two license files — document why both
LICENSE and LICENSE.md exist, or consolidate
- NEWS.md — add a brief note at top or in README explaining what this file is for
- llms.txt vs index.md — document the distinction (LLM-readable vs human-readable site index)
- Articles vs vignettes — add a README note clarifying that pkgdown "Articles" are the vignettes, and vignettes are viewable in R via
vignette("name", package = "rfaR")
- HTML files in repo — pkgdown build artifacts shouldn't be committed; add to
.gitignore
- project-set.md — move out of
docs/articles (hard to find there); reference prominently from README or relocate to top-level docs
- Validation images in articles — add a note in each article explaining these are reference outputs for comparison
- IEEE citation style — match other RMC code (Numerics, BestFit) for consistency across the RMC ecosystem
- Add ORCIDs for anyone with one
Feedback source
Raised by Sadie (comments G3 and H).
A collection of smaller documentation structure improvements raised during package review.
Items
LICENSEandLICENSE.mdexist, or consolidatevignette("name", package = "rfaR").gitignoredocs/articles(hard to find there); reference prominently from README or relocate to top-level docsFeedback source
Raised by Sadie (comments G3 and H).