Skip to content

fix: resolve more intra-repo doc links and add tests #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgaponov merged 7 commits into from
Jul 15, 2026
Merged

fix: resolve more intra-repo doc links and add tests #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f5d6e68
fix: resolve more intra-repo doc links and add tests
dgaponov Jul 13, 2026
d3c256a
feat: surface README "For AI agents" section in INDEX.md
dgaponov Jul 14, 2026
2548bf8
feat(buildDocs): parse READMEs with @gravity-ui/readme-validator
dgaponov Jul 15, 2026
d02a1eb
fix: require @gravity-ui/readme-validator ^1.2.3 for its CJS build
dgaponov Jul 15, 2026
dd29751
chore: lock @gravity-ui/readme-validator 1.2.3 from registry
dgaponov Jul 15, 2026
4270cdb
fix
dgaponov Jul 15, 2026
7ab37dc
fix
dgaponov Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ jobs:
run: npm run lint
- name: Typecheck
run: npm run typecheck
- name: Test
run: npm test
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,6 @@ generated `INDEX.md` is read from that `package.json` — pass them explicitly
Pass a custom `DocsConfig` to change the sources, output directory or INDEX
section order. Intra-repo `README.md` links are rewritten to resolve inside the
output; links to docs that aren't shipped are unwrapped to plain text.

The package README's `For AI agents` section, when present, is cleaned and placed
at the top of the generated `INDEX.md`.
Loading
Loading