Skip to content

Commit 38fddce

Browse files
Bordaclaude
andcommitted
docs: add llms.txt, robots.txt, JSON-LD schema markup
- Add docs/llms.txt for AI crawler discovery with per-plugin doc links - Add docs/robots.txt explicitly allowing GPTBot, ClaudeBot, PerplexityBot and other AI crawlers - Add docs/overrides/base.html with JSON-LD Organization + WebSite + SoftwareApplication structured data on index page - Fix mkdocs.yml site_url/repo_url/repo_name from .local placeholder to Borda/AI-Rig; add copyright, social links, git-revision-date-localized + social plugins - Convert plugin docs (codemap/develop/foundry/oss/research) from bare symlinks to files with metadata frontmatter + snippets include - Add FAQ section to docs/index.md (7 questions covering validate-first, calibration bias, blast-radius, plugin independence) - Add separate mdformat pre-commit hook for docs/ with mkdocs-specific extensions - Add mkdocs-git-revision-date-localized-plugin to docs/requirements.txt --- Co-authored-by: Claude Code <noreply@anthropic.com>
1 parent 5109469 commit 38fddce

13 files changed

Lines changed: 230 additions & 12 deletions

.pre-commit-config.yaml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ repos:
8787
hooks:
8888
- id: mdformat
8989
name: 📝 mdformat (general)
90-
exclude: ^plugins/(?!.*README\.md$)
90+
exclude: ^(plugins/(?!.*README\.md$)|docs/)
9191
args: ["--number", "--wrap=no"]
9292
additional_dependencies:
9393
- mdformat-gfm
@@ -97,6 +97,17 @@ repos:
9797
- mdformat-beautysh
9898
- mdformat-admon
9999
- mdformat-web
100+
- id: mdformat
101+
name: 📝 mdformat (docs)
102+
files: ^docs/
103+
args: ["--number", "--wrap=no"]
104+
additional_dependencies:
105+
- mdformat-mkdocs
106+
- mdformat-ruff
107+
- mdformat-frontmatter
108+
- mdformat-config
109+
- mdformat-beautysh
110+
- mdformat-web
100111

101112
- repo: https://github.com/lycheeverse/lychee.git
102113
rev: lychee-v0.23.0
File renamed without changes.

docs/codemap.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/codemap.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
description: 'Claude Code codemap plugin: Python structural indexer providing import graphs, blast-radius scores, and function call graphs for instant codebase-aware agent context.'
3+
---
4+
5+
--8<-- "plugins/codemap/README.md"

docs/develop.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/develop.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
description: 'Claude Code develop plugin: six validate-first workflows — plan, feature, fix, refactor, debug, review — with mandatory test gates for Python/ML projects.'
3+
---
4+
5+
--8<-- "plugins/develop/README.md"

docs/foundry.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/foundry.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
description: 'Claude Code foundry plugin: 8 specialist agents, calibration benchmarks, config audit, and a self-improvement loop for professional AI-assisted Python/ML development.'
3+
---
4+
5+
--8<-- "plugins/foundry/README.md"

docs/index.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Five Claude Code plugins — foundry, oss, develop, research, codemap — that enforce specialist agents, validate-first workflows, and calibrated quality gates for Python/ML OSS projects.
3+
---
4+
15
# 🤖 Borda's AI-Rig
26

37
> Five plugins that turn Claude Code into a disciplined development partner
@@ -163,6 +167,38 @@ The plugins are designed to be composed. Here are three workflows that span the
163167

164168
______________________________________________________________________
165169

170+
## Frequently Asked Questions
171+
172+
??? question "What is Borda's AI-Rig?"
173+
174+
Borda's AI-Rig is a suite of five Claude Code plugins — foundry, oss, develop, research, and codemap — that enforce specialist routing, validate-first discipline, and calibrated quality gates across the full Python/ML OSS development lifecycle. Each plugin targets a distinct part of the practitioner loop and is designed to compose with the others.
175+
176+
??? question "How is this different from just prompting Claude?"
177+
178+
Without AI-Rig, one generalist model handles architecture, implementation, documentation, linting, testing, and performance with no boundary enforcement. Corrections made in one session evaporate. AI-Rig closes the feedback loop: each part of the loop has a dedicated skill backed by a calibrated specialist agent that enforces discipline at every gate and feeds corrections back into its own instructions automatically via `/foundry:distill`.
179+
180+
??? question "What does 'validate-first' mean?"
181+
182+
Validate-first means you must prove you understand the problem before writing production code. `/develop:feature` requires a failing demo test before implementation. `/develop:fix` requires a failing regression test that reproduces the bug before applying any fix. If you cannot write the test, the problem is underspecified.
183+
184+
??? question "What is calibration bias?"
185+
186+
Calibration bias measures the gap between an agent's stated confidence and its actual recall on synthetic test problems. A bias of +0.15 means the agent says it is 90% confident but is only right 75% of the time. `/foundry:calibrate` benchmarks this for every agent and surfaces agents that are systematically overconfident or underconfident.
187+
188+
??? question "What is a blast-radius score?"
189+
190+
Blast-radius score (from the codemap plugin) measures how many modules would be affected if a given module changed. `scan-query rdeps mypackage.auth` returns every module that imports `auth`. High blast-radius modules are the riskiest to refactor — codemap surfaces these before you touch anything.
191+
192+
??? question "Does this work without all five plugins?"
193+
194+
Yes. Each plugin installs independently. foundry is strongly recommended as a base since it provides the specialist agents the other plugins dispatch to. Without foundry, the other plugins fall back to a generic agent with a role-description prompt.
195+
196+
??? question "How do I know if my agent configuration has drifted?"
197+
198+
Run `/foundry:audit` — it runs 29 checks across hooks, settings, agent routing, and rule files. Zero critical findings means the configuration is healthy. Run it weekly or after any Claude Code update.
199+
200+
______________________________________________________________________
201+
166202
## 🤝 Contributing
167203

168204
The agent and skill source lives in `plugins/` — one directory per plugin, each with its own `skills/`, `agents/`, and `rules/` subdirectories. If you find a gap in agent behavior, the right fix is usually a targeted edit to the agent's instruction file, not a new skill. If you find a workflow that should be a skill, open an issue describing the before/after and the command you wish existed.

docs/llms.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Borda's AI-Rig
2+
3+
> Five Claude Code plugins for Python/ML OSS development:
4+
> specialist agents, calibrated workflows, validate-first discipline.
5+
6+
## Documentation
7+
8+
- [Overview](https://borda.github.io/AI-Rig/): Plugin suite — install, quick-start, how plugins compose
9+
- [foundry](https://borda.github.io/AI-Rig/foundry/): Base infrastructure — 8 specialist agents, calibration, audit, self-improvement
10+
- [oss](https://borda.github.io/AI-Rig/oss/): OSS maintainer workflows — parallel PR review, resolve feedback, SemVer releases
11+
- [develop](https://borda.github.io/AI-Rig/develop/): Validate-first development — feature, fix, refactor, debug with mandatory test gates
12+
- [research](https://borda.github.io/AI-Rig/research/): Structured ML experiments — SOTA search, design review, automated improvement loop
13+
- [codemap](https://borda.github.io/AI-Rig/codemap/): Python structural indexer — import graph, blast-radius, function call graph
14+
15+
## Optional
16+
17+
- [GitHub Repository](https://github.com/Borda/AI-Rig): Source code and plugin files
18+
- [Sitemap](https://borda.github.io/AI-Rig/sitemap.xml): All pages

0 commit comments

Comments
 (0)