Skip to content

fix(docs): correct broken agent index shortcuts #109

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
y0u-0 merged 1 commit into from
Sep 5, 2026
Merged

fix(docs): correct broken agent index shortcuts #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions apps/docs/src/lib/llms.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ describe('buildLlmsText', () => {
}
})

it('links section indexes at their published markdown routes', () => {
expect(text).toContain('[Getting started](https://genie-react.com/docs/getting-started.md)')
expect(text).toContain('[Tools](https://genie-react.com/docs/tools.md)')
})

it('groups pages into sections with absolute markdown links', () => {
expect(text).toContain('## Getting started')
expect(text).toContain(
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/src/lib/llms.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export function buildLlmsText(pages: readonly LlmsPageEntry[]): string {

> ${appDescription}

The genie-react package connects a running React or React Native app to a local hub. The @genie-react/cli package sends tool calls to it. Every page link below points at markdown; remove the .md suffix to read it as HTML.
The genie-react package connects a running React or React Native app to a local hub. The @genie-react/cli package sends tool calls to it. Every page link below points at markdown. Use the site navigation to read the HTML pages.

## When to use Genie React

Expand All @@ -48,7 +48,7 @@ Use Genie React to inspect a running app:

Use a local development build. Inspect source separately when runtime evidence leaves a question open.

Run \`npx @genie-react/cli\` in the app folder. Follow [Getting started](${siteUrl}/docs/getting-started/index.md). Check [CLI output](${siteUrl}/docs/getting-started/cli-output.md) for JSON framing and release differences. Discover the running app with \`npx @genie-react/cli tools\`; use [Tools](${siteUrl}/docs/tools/index.md).
Run \`npx @genie-react/cli\` in the app folder. Follow [Getting started](${siteUrl}/docs/getting-started.md). Check [CLI output](${siteUrl}/docs/getting-started/cli-output.md) for JSON framing and release differences. Discover the running app with \`npx @genie-react/cli tools\`; use [Tools](${siteUrl}/docs/tools.md).

## Machine-readable resources

Expand Down
Loading