-
Notifications
You must be signed in to change notification settings - Fork 42
Expand file tree
/
Copy path.coderabbit.yaml
More file actions
32 lines (30 loc) · 1.78 KB
/
Copy path.coderabbit.yaml
File metadata and controls
32 lines (30 loc) · 1.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# https://docs.coderabbit.ai/guides/configure-coderabbit
language: "en-US"
reviews:
path_instructions:
- path: 'static/llms.txt'
instructions: >-
HAND-CURATED llms.txt INDEX. This file (https://llmstxt.org/) is served
verbatim at /llms.txt and is NOT auto-generated: the
`docusaurus-plugin-llms` plugin is configured with
`generateLLMsTxt: false` in docusaurus.config.js, so the plugin only
emits /llms-full.txt and leaves this curated index untouched. When this
file changes, verify: (1) every link is an absolute
https://docs.gruntwork.io/<slug> URL that resolves to a real page.
Because the docs preset uses `routeBasePath: "/"`, a slug maps directly
to a content file under docs/ (e.g. /2.0/docs/overview/getting-started/
-> docs/2.0/docs/overview/getting-started/, with `index.md` serving the
directory root). Cross-check each slug against a file under docs/ and
against the redirects in src/redirects.js; flag any link whose target
does not exist. (2) The file still parses as valid llms.txt: a single
`# Title` H1, an optional `> summary` blockquote, then `##` sections of
`- [label](url): description` list items. (3) Each description still
accurately reflects the page it links to. Flag broken or stale links at
HIGH.
- path: 'docs/**/*.{md,mdx}'
instructions: >-
LLMS.TXT DRIFT CHECK. static/llms.txt curates a SUBSET of these pages by
slug. Flag at HIGH only if this PR renames, moves, or deletes a page
whose slug is referenced in static/llms.txt (read that file for the slug
list), or adds a NEW top-level section peering with the index's `##`
groups. Do NOT flag ordinary body edits or unreferenced pages.