Skip to content

Fix and validate rendered guidance examples - #295

Merged
nahiyankhan merged 1 commit into
mainfrom
fix/validate-docs-examples
Sep 11, 2026
Merged

nahiyankhan merged 1 commit into
mainfrom
fix/validate-docs-examples

Conversation

@nahiyankhan

@nahiyankhan nahiyankhan commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

Category: fix
User Impact: Readers see guidance examples that pass the parser used by ghost.

Problem: Two landing-page examples used material globs even though ghost requires explicit file paths.

Solution: Replace those globs with explicit paths and extract the example data so tests parse the same examples that the page renders.

Compatibility: No CLI, package schema, layout, or style changes.

Scope: One of five independent PRs split from the original #291. This branch targets main and contains only this concern, its tests, and its documentation.

Related: Enforce resolved material access boundaries, Preserve guidance meaning in CLI output, Report incomplete guidance loading, Add read-only installed skill checks.

Validation:

  • pnpm run quality:all: passed on this standalone branch, including build, package/release checks, tests (229 passed), workspace builds, and package validations.
  • Pre-commit checks and git diff origin/main...HEAD --check: passed.
  • Fresh dependency installation hit registry checksum errors. Validation used an isolated copy of the existing checkout's dependencies; the lockfile is unchanged.

Changeset: Not needed: private docs-site data and tests only.

ghost Review: Docs review packet assembled. Source inspection found no markup or style changes; the visual check is advisory. Rendered visual verification was not performed. Unbound test/data files and nodes without checks remain coverage gaps. Used the current ghost review --package apps/docs/.ghost --base origin/main --format json and inspected ghost manifest; the older ghost check, --include-memory, and dump:cli-help workflows are unavailable in this checkout.

File changes (3 files)
File Purpose
apps/docs/src/data/guidance-examples.ts Extract the examples and replace invalid material globs.
apps/docs/src/pages/index.astro Import shared example data without changing rendered markup or styles.
packages/ghost/test/docs-examples.test.ts Validate the rendered examples through the node parser.

Screenshots/Demos: Not captured: example paths and data placement changed, with no layout or style edits.

@nahiyankhan
nahiyankhan marked this pull request as ready for review September 11, 2026 05:34
@nahiyankhan
nahiyankhan merged commit 516b4a8 into main Sep 11, 2026
6 checks passed
@nahiyankhan
nahiyankhan deleted the fix/validate-docs-examples branch September 11, 2026 05:34
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