Skip to content

Docs: retire parent references - #21

Merged
aidanmoller merged 4 commits into
mainfrom
docs-retire-parent-references
Sep 7, 2026
Merged

Docs: retire parent references#21
aidanmoller merged 4 commits into
mainfrom
docs-retire-parent-references

Conversation

@aidanmoller

Copy link
Copy Markdown
Contributor

Includes the following commits:

  • docs: restore the support guide the security policy points to
  • docs: describe the repository the licence actually covers
  • docs: name both copyright holders in the repository licence
  • chore: remove the walkthrough built for the retired parent

The publication restructure moved the package from aciR/ to acir/ and left
SUPPORT.md behind, so the security policy's one outbound link -- the file it
sends numerical-error reports to -- resolved to nothing on the tab GitHub
renders it in. The guide is carried forward and corrected to the package it
now describes: the three current vignette titles, aci_range rather than the
retired aci_cir, the numerical-disagreement issue template, and the evidence
register that records the tolerance each graded quantity meets.

It is .Rbuildignore'd like API_STABILITY.md, so it reaches the website without
becoming a non-standard top-level file in the tarball.
The third-party attribution block still named aciR/ for the package and docs/
for the documents that quote the reference MATLAB verbatim. Neither path
exists: the package is acir/, the verbatim quotations are in tools/design/ and
tools/oracle/, and the development records are in dev/. A scope clause that
names absent directories states the licence's reach incorrectly, which is the
one thing this file exists to state.
The package's own LICENSE and LICENSE.md name Aidan Moller and Max Moldovan;
the repository licence above them still named one. The repository is joint
since the hybrid, so the two files now agree.
tools/walkthrough/ documented aciR 0.2.3: it loads library(aciR), reads its
signals from that package's inst/extdata, tells the reader to install
subdir = "aciR", and calls five functions acir does not export (aci_cir,
aci_dyad_components, aci_enso_components, aci_enso_parameters,
aci_predprey_components). Its build script copies the render into
aciR/pkgdown/assets/ and so exits at its own guard, and no walkthrough is
published on the site.

Retargeting it is not an edit: acir ships neither inst/extdata nor data/, so
the two input signals would have to become package data first. That is a
design decision for a walkthrough written against the current API. The
document survives at tag parents-final, alongside the package it describes.

The gitignore entries for its render scratch go with it.
@aidanmoller
aidanmoller merged commit d938f7d into main Sep 7, 2026
@aidanmoller
aidanmoller deleted the docs-retire-parent-references branch September 7, 2026 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants