Skip to content

Commit c340f65

Browse files
author
Codex
committed
feat(site): build the coding agent tips publication
why: - make the field guide inspectable as a focused publication instead of a claude-only repository archive - preserve markdown as canonical content while adding starlight navigation, search, and accessible responsive structure evidence: - implemented the approved homepage and guide concepts with the locked public identity, exact color system, self-hosted fonts, and evidence rail - migrated active pages to validated frontmatter and canonical public routes verified: - bun run check - bun run build - desktop and mobile browser review at 375, 768, 1024, and 1440 pixels - exact homepage h1 appears once and tested routes have no horizontal overflow intentionally unverified: - production hosting, custom-domain behavior, and github pages remain gated on the public cutover
1 parent a88259c commit c340f65

25 files changed

Lines changed: 2127 additions & 37 deletions

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ docs/upstream-watcher-design.md
99
!.claude/commands/
1010
!.claude/rules/
1111
node_modules/
12+
.astro/
13+
dist/
14+
playwright-report/
15+
test-results/
1216
.DS_Store
1317
*.pyc
1418
__pycache__/

astro.config.mjs

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
import sitemap from '@astrojs/sitemap';
2+
import starlight from '@astrojs/starlight';
3+
import icon from 'astro-icon';
4+
import { defineConfig } from 'astro/config';
5+
6+
const repository = 'https://github.com/anipotts/coding-agent-tips';
7+
8+
export default defineConfig({
9+
site: 'https://agents.anipotts.com',
10+
output: 'static',
11+
integrations: [
12+
icon({
13+
include: {
14+
ph: ['app-window', 'terminal-window', 'brain', 'git-branch', 'arrow-right', 'arrow-up-right'],
15+
},
16+
}),
17+
sitemap(),
18+
starlight({
19+
title: 'coding agent tips',
20+
description:
21+
'evidence-backed guidance for coding agents in production software, from individual projects to startups and big tech.',
22+
customCss: ['./src/styles/global.css'],
23+
components: {
24+
Header: './src/components/StarlightHeader.astro',
25+
PageSidebar: './src/components/StarlightPageSidebar.astro',
26+
PageTitle: './src/components/StarlightPageTitle.astro',
27+
},
28+
social: [{ icon: 'github', label: 'GitHub', href: repository }],
29+
editLink: { baseUrl: `${repository}/edit/main/` },
30+
lastUpdated: false,
31+
sidebar: [
32+
{
33+
label: 'guides',
34+
items: [
35+
{ label: 'all guides', slug: 'guides' },
36+
{ label: 'codex', slug: 'guides/codex' },
37+
{ label: 'claude code', slug: 'guides/claude-code' },
38+
{ label: 'operating system', slug: 'guides/operating-system' },
39+
],
40+
},
41+
{
42+
label: 'market',
43+
items: [
44+
{ label: 'market map', slug: 'market' },
45+
{ label: 'hardware', slug: 'market/hardware' },
46+
],
47+
},
48+
{
49+
label: 'field work',
50+
items: [
51+
{ label: 'field lab', slug: 'field-lab' },
52+
{ label: 'method', slug: 'method' },
53+
{ label: 'changes', slug: 'changes' },
54+
{ label: 'legacy', slug: 'legacy' },
55+
],
56+
},
57+
],
58+
}),
59+
],
60+
});

bun.lock

Lines changed: 1207 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,41 @@
1-
# guide index
1+
---
2+
title: guides
3+
description: decision-oriented guides to codex, claude code, and shared agent engineering practice.
4+
products: [codex, claude-code]
5+
lastVerified: 2026-08-07
6+
status: current
7+
evidence: [source-verified, inference]
8+
sources: [openai-codex-manual, anthropic-claude-overview]
9+
evidenceRail:
10+
- kind: source-verified
11+
label: primary product guides
12+
section: primary-guides
13+
- kind: inference
14+
label: decision-oriented structure
15+
section: choosing-a-stack
16+
---
217

318
the field guide is organized by decision rather than feature count.
419

520
## primary guides
621

7-
- [codex](./codex/README.md)
8-
- [claude code](./claude-code/README.md)
22+
- [codex](/guides/codex/)
23+
- [claude code](/guides/claude-code/)
924

1025
## shared practice
1126

12-
- [operating system](./shared/operating-system.md)
13-
- [methodology](./methodology.md)
14-
- [field lab](./field-lab/README.md)
15-
- [decision record](./decisions/README.md)
27+
- [operating system](/guides/operating-system/)
28+
- [methodology](/method/)
29+
- [field lab](/field-lab/)
30+
- [decision record](https://github.com/anipotts/coding-agent-tips/tree/main/docs/decisions)
1631

1732
## choosing a stack
1833

19-
- [market map](./market/README.md)
20-
- [hardware economics](./market/hardware.md)
34+
- [market map](/market/)
35+
- [hardware economics](/market/hardware/)
2136

2237
## compatibility
2338

24-
- [legacy tools](./legacy-tools.md)
39+
- [legacy tools](/legacy/)
2540

26-
product facts are tracked in [sources.json](./sources.json). each page distinguishes hands-on evidence, source-verified facts, and inference.
41+
product facts are tracked in the repository [source registry](https://github.com/anipotts/coding-agent-tips/blob/main/docs/sources.json). each page distinguishes hands-on evidence, source-verified facts, and inference.

docs/changes.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: latest changes
3+
description: material changes to the guide, its evidence, and its recommendations.
4+
products: [cross-runtime]
5+
lastVerified: 2026-08-07
6+
status: current
7+
evidence: [hands-on, source-verified]
8+
sources: [openai-codex-manual, anthropic-claude-overview]
9+
evidenceRail:
10+
- kind: source-verified
11+
label: codex manual review
12+
section: '2026-08-07'
13+
sourceId: openai-codex-manual
14+
- kind: source-verified
15+
label: claude code 2.1.224 review
16+
section: '2026-08-07'
17+
sourceId: anthropic-claude-overview
18+
- kind: hands-on
19+
label: field guide v4 reset
20+
section: '2026-08-07'
21+
---
22+
23+
## 2026-08-07
24+
25+
### field guide v4 reset
26+
27+
- reframed the repository around codex and claude code as co-equal primary guides.
28+
- added the surface, harness, model, and orchestration taxonomy.
29+
- replaced activity automation with read-only source and build verification.
30+
- established the field lab, evidence rail, and public decision record.
31+
- froze historical claude code tools through 2026-11-05.
32+
33+
### source review
34+
35+
- codex guidance was checked against the official manual and package 0.147.0.
36+
- claude code guidance was checked against official documentation and package 2.1.224.
37+
- current claude code hands-on comparison remains pending.
38+
39+
changes below this point belong to the legacy tool era and remain available in
40+
the repository [changelog](https://github.com/anipotts/coding-agent-tips/blob/main/CHANGELOG.md).

docs/claude-code/README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,36 @@
1-
# claude code field guide
2-
3-
<!-- guide-meta: {"products":["claude-code"],"last_verified":"2026-08-07","evidence":["source-verified"],"source_ids":["anthropic-claude-overview","anthropic-features-overview","anthropic-desktop"]} -->
1+
---
2+
title: claude code field guide
3+
description: source-verified guidance for claude code terminal, desktop, ide, agents, hooks, and permissions.
4+
products: [claude-code]
5+
lastVerified: 2026-08-07
6+
status: pending
7+
evidence: [source-verified, unknown]
8+
sources: [anthropic-claude-overview, anthropic-features-overview, anthropic-desktop]
9+
evidenceRail:
10+
- kind: source-verified
11+
label: claude code overview
12+
section: current-shape
13+
sourceId: anthropic-claude-overview
14+
- kind: source-verified
15+
label: current features
16+
section: skills-hooks-plugins-and-agents
17+
sourceId: anthropic-features-overview
18+
- kind: source-verified
19+
label: desktop documentation
20+
section: desktop-and-context-switch-cost
21+
sourceId: anthropic-desktop
22+
- kind: unknown
23+
label: current hands-on rerun pending
24+
section: professional-default
25+
---
426

527
evidence: historical hands-on use; current capabilities are source-verified through 2.1.224
628

729
last verified: 2026-08-07
830

931
primary source: [official claude code documentation](https://code.claude.com/docs/en)
1032

11-
local note: 2.1.220 is installed, but the current hands-on protocol in [methodology](../methodology.md) has not been rerun for this reset. recommendations below that depend on current product behavior are therefore source-verified rather than presented as fresh comparative testing.
33+
local note: 2.1.220 is installed, but the current hands-on protocol in [methodology](/method/) has not been rerun for this reset. recommendations below that depend on current product behavior are therefore source-verified rather than presented as fresh comparative testing.
1234

1335
## current shape
1436

docs/codex/README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
1-
# codex field guide
2-
3-
<!-- guide-meta: {"products":["codex"],"last_verified":"2026-08-07","evidence":["hands-on","source-verified"],"source_ids":["openai-codex-manual","git-worktrees"]} -->
1+
---
2+
title: codex field guide
3+
description: operating codex across cli, desktop, ide, cloud, worktrees, permissions, and durable configuration.
4+
products: [codex]
5+
lastVerified: 2026-08-07
6+
status: current
7+
evidence: [hands-on, source-verified, inference]
8+
sources: [openai-codex-manual, git-worktrees]
9+
evidenceRail:
10+
- kind: source-verified
11+
label: codex manual
12+
section: current-shape
13+
sourceId: openai-codex-manual
14+
- kind: source-verified
15+
label: git worktree behavior
16+
section: worktrees-and-parallelism
17+
sourceId: git-worktrees
18+
- kind: hands-on
19+
label: codex-cli 0.146.0
20+
section: the-working-loop
21+
- kind: inference
22+
label: professional default
23+
section: professional-default
24+
---
425

526
evidence: hands-on through `codex-cli 0.146.0`; source-verified through 0.147.0
627

docs/field-lab/README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# field lab
1+
---
2+
title: field lab
3+
description: reproducible scenarios, sanitized run records, public artifacts, and explicit limitations.
4+
products: [codex, claude-code]
5+
lastVerified: 2026-08-07
6+
status: current
7+
evidence: [hands-on, inference, unknown]
8+
sources: []
9+
evidenceRail:
10+
- kind: hands-on
11+
label: codex launch baseline
12+
section: launch-baseline
13+
- kind: inference
14+
label: operator-centered protocol
15+
section: interpretation
16+
- kind: unknown
17+
label: claude code rerun pending
18+
section: launch-baseline
19+
---
220

321
the field lab evaluates coding-agent systems through repeatable engineering work.
422
it measures what the operator must understand, supervise, recover, and verify.
@@ -33,7 +51,7 @@ task specification.
3351

3452
## published data
3553

36-
run records conform to [run.schema.json](./run.schema.json). public artifacts may
54+
run records conform to the repository [run schema](https://github.com/anipotts/coding-agent-tips/blob/main/docs/field-lab/run.schema.json). public artifacts may
3755
include commits, pull requests, test logs, screenshots, and concise design-review
3856
notes.
3957

docs/legacy-tools.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1-
# legacy claude code tools
2-
3-
<!-- guide-meta: {"products":["cc","lore","time"],"last_verified":"2026-08-07","evidence":["retired"],"source_ids":["anthropic-features-overview"]} -->
1+
---
2+
title: legacy claude code tools
3+
description: compatibility and retirement policy for the historical cc, lore, time, hook, and example surfaces.
4+
products: [cc, lore, time]
5+
lastVerified: 2026-08-07
6+
status: legacy
7+
evidence: [source-verified]
8+
sources: [anthropic-features-overview]
9+
evidenceRail:
10+
- kind: source-verified
11+
label: current native features
12+
section: why-the-tools-are-retiring
13+
sourceId: anthropic-features-overview
14+
- kind: unknown
15+
label: no automatic migration parity
16+
section: migration
17+
---
418

519
status: retired from active development
620

docs/market/README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
1-
# market map for coding-agent systems
2-
3-
<!-- guide-meta: {"products":["market"],"last_verified":"2026-08-07","evidence":["hands-on","source-verified","inference"],"source_ids":["openai-codex-manual","anthropic-claude-overview","vscode-agent-host","cursor-docs","conductor-harnesses","t3-code","opencode","kimi-code","kimi-k3","qwen-code","qwen-models","grok-build","grok-4-5"]} -->
1+
---
2+
title: market map for coding-agent systems
3+
description: choose a coding-agent stack by separating surfaces, harnesses, models, and orchestration.
4+
products: [market]
5+
lastVerified: 2026-08-07
6+
status: current
7+
evidence: [hands-on, source-verified, inference]
8+
sources: [openai-codex-manual, anthropic-claude-overview, vscode-agent-host, cursor-docs, conductor-harnesses, t3-code, opencode, kimi-code, kimi-k3, qwen-code, qwen-models, grok-build, grok-4-5]
9+
evidenceRail:
10+
- kind: hands-on
11+
label: current codex use
12+
section: contender-map
13+
- kind: source-verified
14+
label: official product sources
15+
section: contender-map
16+
- kind: inference
17+
label: operating-model recommendations
18+
section: chooser-with-defaults
19+
- kind: unknown
20+
label: products awaiting hands-on review
21+
section: contender-map
22+
---
423

524
evidence: codex is current hands-on; claude code combines historical use with current source verification; other products are source-verified
625

@@ -94,7 +113,7 @@ subscription or token price is only one part of the system:
94113
- maintenance cost: config, plugins, provider adapters, updates, and policy.
95114
- reliability cost: recovery when a session, model, network request, or tool call fails.
96115

97-
the [hardware guide](./hardware.md) covers the local resource side.
116+
the [hardware guide](/market/hardware/) covers the local resource side.
98117

99118
## recommendation
100119

0 commit comments

Comments
 (0)