Add structured reference page headings to pkgdown site#22
Open
beckyfisher wants to merge 3 commits into
Open
Conversation
Open
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
2 participants
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.
Closes #19
The _pkgdown.yml was empty, causing the pkgdown reference page to render as a flat alphabetical list with no organisation. This PR adds a structured heading hierarchy and a data-raw script to keep it in sync as the package evolves.
Changes
_pkgdown.yml — generated file with a six-section reference structure:
Package overview
Individual SSD datasets (subtitled by source organisation)
Multi-chemical SSD datasets
Multi-chemical derived SSD datasets
Fitted SSD results
Package functions
data-raw/build_pkgdown_yml.R — script that regenerates _pkgdown.yml by scanning man/*.Rd at runtime. Individual datasets are classified automatically by prefix; package functions are captured as a residual catch-all so new exports appear without manual edits. Re-run after devtools::document() whenever datasets or functions are added.
Note: PR #20 addresses the same issue via a similar approach and will be closed as superseded by this PR.