Skip to content
This repository was archived by the owner on Jun 3, 2026. It is now read-only.

Commit c0ee5fd

Browse files
committed
docs: prefix repo paths with site/ in skills and references
1 parent 8de240c commit c0ee5fd

4 files changed

Lines changed: 11 additions & 9 deletions

File tree

.agents/references/code-verification.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,20 @@
22

33
When writing or auditing documentation, verify every code example against the actual SDK source. Plausible-but-wrong code erodes developer trust faster than missing documentation.
44

5+
The docs site lives under `site/` in this repo. All paths in this guide — including those in skill procedures that reference it — are written relative to the repo root, so they include the `site/` prefix where applicable. Run shell commands like `npm run sdk:clone` from inside `site/` (where `package.json` lives).
6+
57
Use the first tier available in your environment. Fall back only when the preferred tier is unavailable.
68

79
## Tier 1: Local SDK Clones (preferred)
810

911
If you have the local clones populated by `npm run sdk:clone`, read directly from disk — it's faster than network calls and avoids API rate limits:
1012

1113
```
12-
.build/sdk-python/src/strands/[path]
13-
.build/sdk-typescript/strands-ts/src/[path]
14+
site/.build/sdk-python/src/strands/[path]
15+
site/.build/sdk-typescript/strands-ts/src/[path]
1416
```
1517

16-
If the clones aren't present, run `npm run sdk:clone` from the repo root, or fall back to Tier 2.
18+
If the clones aren't present, run `npm run sdk:clone` from `site/`, or fall back to Tier 2.
1719

1820
**Key Python modules** (under `src/strands/`):
1921
- `agent/agent.py``Agent` class, constructor signature, `__call__`/`stream_async`

.agents/references/mdx-authoring.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ async function codeConfigurationOption1() {
7979
```
8080
````
8181

82-
Only the code between markers is rendered. Paths are relative to `src/content/docs/`.
82+
Only the code between markers is rendered. Paths inside the `--8<--` directive are relative to `site/src/content/docs/`; you can also write them relative to the repo root with the `site/` prefix.
8383

8484
**When to skip the imports file:** the page renders no TypeScript snippets, *or* every snippet body genuinely has zero external imports. Otherwise, write the imports file — relying on the imports at the top of the body `.ts` is wrong, since those lines live above the `[start:...]` marker and never appear in rendered docs.
8585

@@ -174,13 +174,13 @@ Link to generated API docs without fragile relative paths:
174174

175175
## Line Length
176176

177-
90 characters maximum for files under `src/content/docs/`. Template literal contents in snippet files must also stay under 90 characters. Prettier does not enforce this automatically.
177+
90 characters maximum for files under `site/src/content/docs/`. Template literal contents in snippet files must also stay under 90 characters. Prettier does not enforce this automatically.
178178

179179
## Gotchas
180180

181181
- **Snippet dedent**: Leading whitespace is automatically stripped from included snippets. If the snippet reference in markdown is indented, content indents to that level.
182182
- **Tab indentation**: Content inside `<Tab>` must not have leading blank lines or it may not render correctly.
183-
- **API docs are symlinked**: `src/content/docs/api/python/_generated` and `typescript/_generated` are symlinks to `.build/api-docs/`. Never edit these directly — they are auto-generated.
183+
- **API docs are symlinked**: `site/src/content/docs/api/python/_generated` and `typescript/_generated` are symlinks to `site/.build/api-docs/`. Never edit these directly — they are auto-generated.
184184
- **No `TabItem`**: The auto-imported component is `Tab`, not `TabItem` (even though Starlight's native component is called TabItem).
185185
- **Code theme**: Uses GitHub Light/Dark themes. Follows Starlight's `[data-theme]` attribute.
186186
- **Formatting**: No semicolons, single quotes, 2-space indent, trailing commas ES5 style (enforced by Prettier).

.agents/skills/docs-audit/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ Assess an existing documentation page. Produces a structured assessment with spe
1818

1919
## Inputs
2020

21-
- **Target page**: File path in `src/content/docs/` or published URL
21+
- **Target page**: File path in `site/src/content/docs/` or published URL
2222
- **Content type**: If known. If not, classify it first.
2323
- **Context** (optional): Community signals, GitHub issues, or specific concerns
2424

2525
## Process
2626

2727
### Step 1: Fetch and classify
2828

29-
Read the source file from `src/content/docs/` in this repo. If you need the published version and have web access, fetch from strandsagents.com.
29+
Read the source file from `site/src/content/docs/` in this repo. If you need the published version and have web access, fetch from strandsagents.com.
3030

3131
Classify the content type (tutorial, howto, reference, explanation, mixed). Note: "mixed" is itself a finding. Pages that mix types are the most common structural problem.
3232

.agents/skills/docs-planner/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Identify gaps in the docs site and produce a prioritized backlog.
1717

1818
### Step 1: Inventory current docs
1919

20-
Read `src/config/navigation.yml` for the full navigation tree — this is the authoritative navigation source for the Astro site, loaded by `astro.config.mjs` via `src/sidebar.ts`. The legacy `mkdocs.yml` is no longer wired into the build; ignore it for navigation purposes. Glob `src/content/docs/**/*.{md,mdx}` for all content files. Classify each by content type (tutorial, how-to, reference, explanation, mixed), coverage area (quickstart, tools, agents, multi-agent, deployment, etc.), and estimated freshness (check lastReviewed frontmatter if available, otherwise flag as unknown).
20+
Read `site/src/config/navigation.yml` for the full navigation tree — this is the authoritative navigation source for the Astro site, loaded by `site/astro.config.mjs` via `site/src/sidebar.ts`. Glob `site/src/content/docs/**/*.{md,mdx}` for all content files. Classify each by content type (tutorial, how-to, reference, explanation, mixed), coverage area (quickstart, tools, agents, multi-agent, deployment, etc.), and estimated freshness (check lastReviewed frontmatter if available, otherwise flag as unknown).
2121

2222
### Step 2: Identify gaps
2323

0 commit comments

Comments
 (0)