docs: validate landing-page demo asset and CTAs - #185
Conversation
|
All checks complete. Here is the review. Review: commit
|
| Helper | Test |
|---|---|
markdown_anchor_slug |
heading_slug_matches_install_anchor_shape |
extract_markdown_links |
extracts_markdown_links_outside_code_fences |
extract_html_sources |
extracts_html_sources, ignores_html_sources_inside_code_fences |
collect_markdown_anchors |
collects_heading_anchors_outside_code_fences |
validate_no_remote_embeds |
rejects_remote_embeds, ignores_remote_embeds_inside_code_fences |
validate_local_markdown_link |
validates_local_markdown_link_when_file_and_anchor_exist, rejects_local_markdown_link_when_anchor_does_not_match |
Confirmed that ~~~ fence style does not appear anywhere in docs/src/, so the ```-only toggle is not a gap in practice.
5. Documentation
All added items are private functions or clap enum variants; no new pub items requiring rustdoc. Cmd::ValidateLandingPage carries the required clap doc comment. xtask/AGENTS.md updated accurately.
Punch list
Nothing blocking. One advisory item:
xtask/src/main.rs:~290—validate_no_remote_embeds(path: &Path, src: &str): the second parameter holds file content, not a source URL. The namesrcis ambiguous alongside the function body's use ofsrcfor embedsrc=attributes. Not a correctness issue; rename tocontentwould improve readability, but this is an xtask private fn and the scope is small.
Verdict: APPROVE
2c29dbc to
768c1a7
Compare
Spec
Fixes #63
Summary
mainafter docs: add landing demo asset and CTA verification #184 landed the public landing-page demo and CTA copycargo xtask validate-landing-pagegate for the merged landing pagemain, reject remote embeds, verify the local HTML demo source, and verify the install CTA anchors resolve to local docs targetsbook.toml, domain, and CNAME unchanged; do not treat deployed-root acceptance as complete whilehttps://plumb.dev/still returns HTTP 403Test plan
cargo xtask validate-landing-pagecargo test -p xtaskcargo fmt --checkcargo clippy -p xtask --all-targets -- -D warningscargo clippy --workspace --all-targets -- -D warningsgit diff --checkdocs/src/**, so no humanizer/banned-phrase rerun was neededNotes for reviewers
mainalready contains the public-facing landing-page asset and CTA copy from docs: add landing demo asset and CTA verification #184; this PR now changes onlyxtask/src/main.rs.maintoday, includingdocs/src/demo-terminal.svgand the current install CTA anchors.https://plumb.dev/still returns HTTP 403, so this PR does not claim deployed-root acceptance.Breaking change?