Add structured heading hierarchy to pkgdown references page#20
Conversation
…cript Agent-Logs-Url: https://github.com/open-AIMS/ssddata/sessions/1aa8c531-38af-419a-b4be-c8ff9ececfa4 Co-authored-by: joethorley <613671+joethorley@users.noreply.github.com>
|
Thanks for putting this together — the structure and approach are very similar to what we landed on, which is a good sign. A few things in this PR needed correcting: the site URL was pointing to bcgov.github.io/ssdtools rather than open-aims.github.io/ssddata, getdata was missing from the Functions section, and the use of utils::data(package = "ssddata") for discovery requires the package to be installed rather than reading directly from man/. We've merged an alternative implementation in #22 that addresses these points and also adds the authors: block and development: mode: auto for the dev/release site split. Everything useful implemented in #20 is present in #22. This PR also makes some other minor tweaks to the documentation workflow. Closing this in favour of #22. |
The
_pkgdown.ymlwas empty, causing pkgdown to render the references page as a flat alphabetical list with no organisation. This adds a proper heading structure and a data-raw script to keep it in sync as datasets are added over time.Changes
_pkgdown.ymlStructured reference section with three top-level headings:
aims_*)anon_*)anzg_*)ccme_*)csiro_*)*_datacombined datasetsanztox_data/wqbench_dataare added)ssd_fitsssd_data_sets,get_ssddata,gm_meandata-raw/build_pkgdown.RNew script to regenerate
_pkgdown.ymldynamically. Queriesutils::data(package = "ssddata")at runtime so re-running it after new datasets are added (especiallyanzg_*) keeps the reference page accurate without manual edits.The "Derived SSD datasets" section is omitted from the current file (no such datasets exist yet) but will appear automatically once
anztox_dataorwqbench_dataland in the package.