Repository navigation
docs(site): repair acquisition, 404 links, lane-leak, and audience-separation findings - #90
Merged
Merged
Conversation
…tion - README: drop dead r-universe badge and install block; keep remotes::install_github plus the v0.1.0 release-attached packages path; point the license link at the GitHub file so the homepage resolves - get-started: teach a reachable install method on the published page (install_github face + prebuilt-release paragraph) and gate it with an acquisition law (positive control fires on a checkout-only face) - tour/extending/scenarios: write bare sibling hrefs so they resolve under /articles/ (the articles/-prefixed forms 404 at render time) - extending-face.R: articles/-prefixed sibling hrefs are a violation; strip the roster prefix so all 91 article entries join the auditable set - test-docs-extending-surface: flip the link-law assertion to the fixed hrefs and add the too-deep and roster-auditability units - pkgdown-coherence: article-tier navbar audience law (bijective, keyed vs internal allowlist), exercised by its own blocks plus firing controls; fix the descending-range idiom in both navbar parsers - _pkgdown.yml: navbar keys on the six user-facing tiers, descs for the four sections missing them, both build faces documented at the config - devlogs/ADRs: scrub /tmp/ scratch pointers and worktree agent-<hex> identifiers from published articles; documented build commands keep their paths
Contributor
Author
|
Post-merge attestation (docs-remediation closure):
Test-plan items resolved:
Closing out: the CRITICAL/HIGH docs findings are repaired and attested on main. Remaining follow-ups live in the docs backlog: the four thin vignettes (scenarios-gallery, peer-evidence, quality-control, signature-extraction) as a task-guide pass, CITATION.cff, and devlog index/title normalization. |
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
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.
Summary
Repairs the CRITICAL and HIGH findings from the dual-lens (junior-user + senior-expert) review of the docs system and pkgdown site.
CRITICAL-1 — acquisition path dead end-to-end
msuiterbinary — verified against the live PACKAGES index); install now points atremotes::install_github("WangLabCSU/msuiter")plus the real v0.1.0 release assets.get-startedarticle: added the install face (pak/remotes/GitHub + release tarball paths) — the page previously had zero install tokens.CRITICAL-2 — three 404 cross-links + LICENSE 404
tour,extending,scenariosarticles: sibling hrefs switched to the bare form (tour.html), which is the form that resolves from pages rendered under/articles/.HIGH-1 — lane-identifier / environment-leak hygiene
agent-<hex8+>lane identifiers and prose/tmp/pointers across the article corpus; ~20 devlog/qmd files scrubbed.[GATED:]tokens and the bare word "lane" are expressly out of scope (amended-law scope note).test-docs-extending-surface.R.HIGH-2 — audience separation (the 63-file devlog at user-facing weight)
tools/extending-face.R: roster hrefs no longer carry thearticles/prefix (91 entries become auditable by the link law; prefix now = violation)._pkgdown.yml: 6 tier navbar keys rewritten for the user-facing face + 25 article descriptions; devlog demoted behind the specialist tiers; both-faces comment added.test-pkgdown-coherence.R(.coh_navbar_audience_law, bijective), kept out of the synthetic-yml law path by design.Local gate
test_dirruns).devtools::check:0 errors ✔ | 2 warnings ✖ | 0 notes ✔(Duration 21m 16.4s; testthat 17m OK; vignette re-build 190s OK). The 2 WARNINGs are the known baseline class (checkbashisms advisory, Rust crate download advisory) — below the PR fix(ci): repair the three scheduled-gate defects behind audit #74 and #76 #89 attested WARN-7 baseline.agent-[0-9a-f]{8,}acrossvignettes/,README.md,_pkgdown.yml→ 0 hits.Test plan
devtools::checkgreen (baseline-class warnings only)