Skip to content

Commit fbfc1e1

Browse files
Bordaclaudecodex
committed
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> Co-authored-by: Codex <codex@openai.com>
1 parent 5109469 commit fbfc1e1

15 files changed

Lines changed: 251 additions & 25 deletions

‎.github/workflows/docs.yml‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,26 @@ jobs:
3232
timeout-minutes: 10
3333
steps:
3434
- name: Checkout (with symlinks)
35-
uses: actions/checkout@v4
35+
uses: actions/checkout@v6
3636
with:
3737
# Symlinks in docs/ point to plugins/*/README.md.
3838
# Default checkout preserves symlinks on Linux — no extra flag needed,
3939
# but stated here explicitly so the dependency is visible.
4040
persist-credentials: false
41+
# git-revision-date plugin requires full history
42+
fetch-depth: 0
4143

4244
- name: Set up Python 3.12
4345
uses: actions/setup-python@v5
4446
with:
4547
python-version: "3.12"
4648
# Pin to exact minor so the build is reproducible across runner updates.
4749

50+
- name: Install native imaging dependencies
51+
# Material's social plugin uses CairoSVG, which needs the native Cairo
52+
# shared library in addition to the Python package.
53+
run: sudo apt-get update && sudo apt-get install --yes libcairo2
54+
4855
- name: Install MkDocs dependencies
4956
# python -m pip ensures we use the pip that belongs to the selected Python,
5057
# not a system pip that may point elsewhere.
@@ -53,6 +60,9 @@ jobs:
5360
- name: Build docs (strict — warnings are errors)
5461
# --strict turns every MkDocs warning into a build failure.
5562
# Remove --strict only if a plugin emits unavoidable warnings.
63+
env:
64+
# Material for MkDocs documents this opt-out for its MkDocs 2.0 notice.
65+
NO_MKDOCS_2_WARNING: "1"
5666
run: python -m mkdocs build --strict
5767

5868
- name: Configure GitHub Pages

‎.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

‎README.md‎

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -532,17 +532,6 @@ Without the plugin: pre-pass review is skipped gracefully (skills check with `cl
532532
533533
</details>
534534
535-
## 🔌 MCP Servers
536-
537-
Two optional MCP servers are defined in `.mcp.json` (defined at the repo root; enable per-machine in `settings.local.json`). Both are **disabled by default**.
538-
539-
| Server | Purpose | Enable |
540-
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
541-
| **openspace** | Skill auto-evolution — reduces token consumption on repeated tasks via `execute_task`, `search_skills`, `fix_skill`, `upload_skill` tools | add `"openspace"` to `enabledMcpjsonServers` |
542-
| **colab-mcp** | GPU workloads via Google Colab (used by `/research:run --colab`) | add `"colab-mcp"` to `enabledMcpjsonServers` |
543-
544-
→ New-machine setup and full reference: [`.claude/README.md` → MCP Servers](.claude/README.md#-mcp-servers)
545-
546535
## 🛠 Recommended Add-ons
547536
548537
### Token Savings (RTK)
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"

0 commit comments

Comments
 (0)