Skip to content

Commit c0c74f0

Browse files
committed
Fix up README sample config
1 parent 2d0798d commit c0c74f0

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

‎packages/starlight-agent-docs/README.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Starlight Agent Docs
1+
# Starlight Agent Docs
22

33
This plugin implements the [`llms.txt`](https://llmstxt.org/) standard, providing markdown versions of pages and an `llms.txt` sitemap for agents to use. It is designed to work on any static hosting service, so it does not rely on responding with `Link` headers or an `Accepts: text/markdown` in the request.
44

@@ -20,31 +20,27 @@ pnpm add @nu-appdev/starlight-agent-docs
2020
Import the plugin in `astro.config.mjs` and add it to Starlight's `plugins`:
2121

2222
- Ensure the `site` setting is configured. This is the base URL that will be used in `/llms.txt`
23-
- Register `starlightAgentDocs()` **after** any themes or plugin that overrides `EditLink`
23+
- Register `starlightAgentDocs()` **after** any theme or plugin that overrides `EditLink`
2424

2525
```js
2626
// astro.config.mjs
2727
import { defineConfig } from 'astro/config';
2828
import starlight from '@astrojs/starlight';
29-
import northwesternTheme from '@nu-appdev/northwestern-starlight-theme';
3029
import starlightAgentDocs from '@nu-appdev/starlight-agent-docs';
3130

3231
export default defineConfig({
33-
site: 'https://sdcc.entapp.northwestern.edu',
32+
site: 'https://docs.example.com',
3433
integrations: [
3534
starlight({
36-
title: 'SDCC Docs',
37-
description: 'Standards and recommendations for the IT@NU community.',
35+
title: 'Example Docs',
36+
description: 'Documentation for Example.',
3837
sidebar: [
39-
{ label: 'Introduction', items: [{ autogenerate: { directory: 'introduction' } }] },
40-
{ label: 'Coding Standards', items: [{ autogenerate: { directory: 'coding-standards' } }] },
41-
{ label: 'Appendices', items: [{ autogenerate: { directory: 'appendix' } }] },
38+
{ label: 'Guides', items: [{ autogenerate: { directory: 'guides' } }] },
39+
{ label: 'Reference', items: [{ autogenerate: { directory: 'reference' } }] },
4240
],
4341
plugins: [
44-
northwesternTheme(),
4542
starlightAgentDocs({
46-
guidance: 'Use the requirement-level definitions when interpreting MUST, SHOULD, and MAY. Pages marked as drafts are not approved requirements.',
47-
fallbackSection: 'Other documentation',
43+
guidance: 'Start with the guides before reading the reference.',
4844
}),
4945
],
5046
}),

0 commit comments

Comments
 (0)