Skip to content

Align skills, AI-doc workflow, and pkgdown skills pages#9

Merged
rkrug merged 2 commits into
mainfrom
dev
Apr 10, 2026
Merged

Align skills, AI-doc workflow, and pkgdown skills pages#9
rkrug merged 2 commits into
mainfrom
dev

Conversation

@rkrug

@rkrug rkrug commented Apr 10, 2026

Copy link
Copy Markdown
Owner

Summary

This PR finalizes the skills/documentation governance work and aligns the repository with the new reusable maintainer standard.

Main changes

  • Added a generic r-package-maintainer skill with reusable governance, validation, branch protection, commit template, and skill design standards.
  • Standardized all package SKILL.md files to a consistent structure with a dedicated ## References section.
  • Added and wired AI-doc artifacts and checks:
    • llms.txt, llms-full.txt
    • scripts/check-ai-docs.sh
    • CI integration in R-CMD-check.
  • Added AI-facing docs pages:
    • vignettes/agent-quick-index.qmd
    • vignettes/api-contracts.qmd.
  • Added pkgdown-rendered skill pages (vignettes/skills-*.qmd) using include-based wrappers with single-source content from inst/skills.
  • Simplified pkgdown Skills navbar to one entry per skill and embedded each skill's references in the same page.
  • Updated release/design docs and changelog sync:
    • NEWS.md
    • PROJECT_DESIGN.md
    • README.md
    • skills index.
  • Updated check strategy in r-package-maintainer to prefer devtools::check() for local audit runs.
  • Updated .Rbuildignore so pkgdown-only skill wrappers are excluded from package-build vignette checks.

Why

  • Keep user docs readable while making machine-oriented docs reliable and maintainable.
  • Eliminate skill-doc duplication by using include wrappers.
  • Make the maintainer workflow portable to other R packages.
  • Ensure audit and release checks are explicit and reproducible.

Validation

  • bash scripts/check-ai-docs.sh -> PASS
  • Rscript -e 'pkgdown::build_site()' -> PASS
  • Rscript -e 'devtools::check()' -> PASS (0 errors, 0 warnings, 0 notes)

Notes

  • Remaining pkgdown accessibility note: missing alt text on README logo image.
  • Branch policy and solo-maintainer bypass guidance are now explicitly documented in skills.

rkrug added 2 commits April 10, 2026 11:37
Behavior and governance updates:
- Add and adopt a generic r-package-maintainer skill with explicit workflow, branch governance, validation, and commit standards.
- Standardize all skill files to a unified structure with a dedicated References section.
- Add explicit solo-maintainer bypass rule semantics (PR-merge-only, no direct push path).

Skills and docs updates:
- Add skills index and rendered skill pages in pkgdown using include-based wrappers from inst/skills sources.
- Keep one wrapper per skill and embed references on the same page to avoid content duplication.
- Update README/PROJECT_DESIGN/NEWS to reflect AI-doc artifacts, skills workflow, and pkgdown skills integration.
- Add AI-doc machine artifacts and mirrors: llms.txt, llms-full.txt, pkgdown/extra copies.

CI and audit tooling:
- Add scripts/check-ai-docs.sh and wire into R-CMD-check workflow.
- Extend r-package-maintainer checklist/standards with pkgdown wrapper and .Rbuildignore rules for pkgdown-only skill wrappers.

Pkgdown and check-related fixes:
- Add skills menu entries (one per skill) and skills articles to _pkgdown.yml.
- Exclude vignettes/skills-*.qmd from R package builds via .Rbuildignore to avoid vignette-engine notes.

Validation run during audit:
- bash scripts/check-ai-docs.sh: PASS.
- Rscript -e 'pkgdown::build_site()': PASS (remaining accessibility note: missing alt text on README logo).
- R CMD check --no-manual .: completed with warnings/notes from local hidden/build artifacts and local check directory context.

Notes:
- This commit intentionally includes governance/doc/skills synchronization and pkgdown-rendering infrastructure as one cohesive change set.
Changes:
- Update r-package-maintainer skill to prefer devtools::check() for local release/audit validation.
- Update maintainer checklist validation section to require devtools::check() as the primary local package check.
- Clarify that R CMD check is used only when explicit tarball-level parity is needed.

Validation run (this commit cycle):
- bash scripts/check-ai-docs.sh: PASS.
- Rscript -e 'pkgdown::build_site()': PASS (accessibility note only: missing alt text on README logo).
- Rscript -e 'devtools::check()': PASS with 0 errors, 0 warnings, 0 notes.

Outcome:
- Commit audit requirement now aligns with requested local check stability preference.
@rkrug rkrug merged commit ddd1bd4 into main Apr 10, 2026
6 checks passed
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.

1 participant