Skip to content

feat(skill): validate links, strip images, include openapi.json and changelog#614

Merged
nicoloboschi merged 6 commits intomainfrom
feat/skill-link-validation-and-openapi
Mar 19, 2026
Merged

feat(skill): validate links, strip images, include openapi.json and changelog#614
nicoloboschi merged 6 commits intomainfrom
feat/skill-link-validation-and-openapi

Conversation

@nicoloboschi
Copy link
Collaborator

Summary

  • Link validation: generation script now fails if any link in the generated skill points outside the skill directory
  • Docusaurus path rewriting: site-root paths like /developer/foo are automatically rewritten to proper relative .md paths within references/
  • Image stripping: markdown and HTML images are removed from all generated files since assets aren't bundled with the skill
  • OpenAPI spec: hindsight-docs/static/openapi.json is copied into references/openapi.json; /api-reference links are rewritten to point at it
  • Changelog: changelog.md is now included from src/pages/ alongside faq and best-practices

Test plan

  • Run ./scripts/generate-docs-skill.sh and confirm it completes without errors
  • Confirm skills/hindsight-docs/references/openapi.json is present
  • Confirm skills/hindsight-docs/references/changelog.md is present
  • Introduce a bad link in a doc and confirm the script exits with an error

@nicoloboschi nicoloboschi force-pushed the feat/skill-link-validation-and-openapi branch from b921e87 to 5201e17 Compare March 19, 2026 09:36
…hangelog

- Add post-processing step to rewrite Docusaurus site-root paths (e.g.
  /developer/foo) to proper relative .md paths within the skill
- Strip markdown and HTML images from all generated files since assets
  are not bundled with the skill
- Copy hindsight-docs/static/openapi.json into references/openapi.json
  and map /api-reference links to it
- Include changelog.md from src/pages/ alongside faq and best-practices
- Add final validation step that fails the build if any link still
  points outside the skill directory
@nicoloboschi nicoloboschi force-pushed the feat/skill-link-validation-and-openapi branch from 549f515 to 14e1cd2 Compare March 19, 2026 10:33
@nicoloboschi nicoloboschi merged commit a706905 into main Mar 19, 2026
39 of 40 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