Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 6 additions & 39 deletions .ai-reviewer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,50 +14,17 @@ anthropic:
default_model: claude-sonnet-4-6
enable_prompt_caching: true

# Doc auto-update — opens a draft PR on merges to master with proposed
# changes to the architecture site (and any Markdown docs that go stale).
# Disabled by default upstream; enabled here so doc-update.yaml has work to do.
# Disabled at the docs cutover: the published docs are now the hand-authored
# Starlight site in docs-site/, not the auto-generated architecture/ HTML.
# Re-enable only if the bot is repointed at generating reference *data* for the
# new site (see the docs-generation plan), not free-form HTML.
# Doc auto-update — historically opened a draft PR on merges to master with
# proposed changes to the generated architecture site. Disabled at the docs
# cutover: the published docs are now the hand-authored Starlight site in
# docs/, not auto-generated HTML, and the legacy architecture/ site has been
# removed. Re-enable only if the bot is repointed at generating reference
# *data* for the new site, not free-form HTML.
doc_generation:
enabled: false
model: claude-sonnet-4-6 # Sonnet: Haiku failed the HTML find/replace patch task
max_files: 15
static_docs_dirs:
- architecture/ # GitHub Pages source for the architecture site
pr_labels:
- automated-docs
- documentation
pr_draft: true

# Source → docs routing. A change whose files match a glob routes deterministically
# to the listed page(s) with no model guess (the fast mapping-hit path); unmapped
# crates fall back to model routing. Globs are fnmatch-style (`*` spans `/`).
documentation:
source_to_docs_mapping:
# Per-crate internals pages (architecture/crates/*.html)
"crates/auth/**": ["architecture/crates/auth.html"]
"crates/node/**": ["architecture/crates/node.html", "architecture/crates/sync.html"]
"crates/context/**": ["architecture/crates/context.html", "architecture/membership-and-leave.html"]
"crates/network/**": ["architecture/crates/network.html", "architecture/wire-protocol.html"]
"crates/server/**": ["architecture/crates/server.html"]
"crates/runtime/**": ["architecture/crates/runtime.html", "architecture/app-lifecycle.html"]
"crates/dag/**": ["architecture/crates/dag.html"]
"crates/sdk/**": ["architecture/crates/sdk.html"]
"crates/meroctl/**": ["architecture/crates/tools.html"]
"crates/merod/**": ["architecture/crates/tools.html"]
# Storage
"crates/store/**": ["architecture/crates/store.html", "architecture/storage-schema.html"]
"crates/storage/**": ["architecture/storage-schema.html", "architecture/migrations.html"]
"crates/storage-macros/**": ["architecture/storage-schema.html"]
# Governance & op-log
"crates/governance-store/**": ["architecture/local-governance.html", "architecture/auto-follow.html"]
"crates/governance-types/**": ["architecture/local-governance.html"]
"crates/authz/**": ["architecture/local-governance.html"]
"crates/op/**": ["architecture/crates/dag.html", "architecture/auto-follow.html"]
"crates/op-adapter/**": ["architecture/crates/dag.html"]
# Subsystems
"crates/config/**": ["architecture/config-reference.html"]
"crates/tee-attestation/**": ["architecture/tee-mode.html"]
3 changes: 1 addition & 2 deletions .github/workflows/ai-review.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ on:
# cost — a review fires on PR open / reopen / draft→ready, not on each
# push. Re-trigger a review by toggling draft or via workflow_dispatch.
types: [opened, reopened, ready_for_review]
# Skipped only when ALL changed files are under docs/architecture/docs-static —
# Skipped only when ALL changed files are under docs/docs-static —
# mixed PRs still trigger a review (standard GitHub Actions paths-ignore semantics).
# Pure-doc PRs are owned by the `Doc Auto-Update` workflow; this avoids paying
# twice for the same diff.
paths-ignore:
- 'docs/**'
- 'architecture/**'
- 'docs-static/**'
workflow_dispatch:
inputs:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/doc-update.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ on:
# infinite loop. Mirrors the paths-ignore in ai-review.yaml.
paths-ignore:
- 'docs/**'
- 'architecture/**'
- 'docs-static/**'
workflow_dispatch:
inputs:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ name: Docs CI
# touches it, so the docs can't silently break. Content-only; no deploy.
on:
pull_request:
paths: ['docs-site/**']
paths: ['docs/**']
push:
branches: [master]
paths: ['docs-site/**']
paths: ['docs/**']

permissions:
contents: read
Expand All @@ -21,13 +21,13 @@ jobs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs-site
working-directory: docs
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
cache-dependency-path: docs-site/package-lock.json
cache-dependency-path: docs/package-lock.json
- run: npm ci
- run: npm run check # astro build + internal link check
25 changes: 7 additions & 18 deletions .github/workflows/docs-site.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
name: Deploy Docs Site (Starlight)

# Builds the Astro Starlight documentation site (docs-site/) and deploys it to
# GitHub Pages — this is now the PUBLISHED docs (it replaced the legacy
# architecture/ site). It publishes Starlight at the Pages root and preserves
# the old hand-built site under /architecture-legacy/ so nothing is lost.
# Rollback: run the (now manual-only) `pages.yml` to republish architecture/.
# Builds the Astro Starlight documentation site (docs/) and deploys it to
# GitHub Pages — this is the published documentation.
on:
push:
branches: [master]
paths:
- 'docs-site/**'
- 'architecture/**'
- 'docs/**'
- '.github/workflows/docs-site.yml'
workflow_dispatch:

Expand All @@ -19,7 +15,6 @@ permissions:
pages: write
id-token: write

# Shares the `pages` concurrency group with pages.yml so the two never race.
concurrency:
group: pages
cancel-in-progress: true
Expand All @@ -37,25 +32,19 @@ jobs:
with:
node-version: 20
cache: npm
cache-dependency-path: docs-site/package-lock.json
cache-dependency-path: docs/package-lock.json

- name: Install
working-directory: docs-site
working-directory: docs
run: npm ci

- name: Build
working-directory: docs-site
working-directory: docs
run: npm run build

# Keep the legacy hand-built site reachable during migration.
- name: Bundle legacy architecture site
run: |
mkdir -p docs-site/dist/architecture-legacy
cp -r architecture/* docs-site/dist/architecture-legacy/

- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v3
with:
path: docs-site/dist
path: docs/dist
- id: deployment
uses: actions/deploy-pages@v4
32 changes: 0 additions & 32 deletions .github/workflows/pages.yml

This file was deleted.

4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ Peer-to-peer application platform with local-first governance, CRDT state sync,
| Work on Calimero Core itself | [Contribute](https://calimero-network.github.io/core/contribute/) — architecture, crate guide, dev workflow |
| Look up a term | [Glossary](https://calimero-network.github.io/core/protocol/glossary/) |

The docs live in [`docs-site/`](docs-site/) (Astro Starlight). The previous
hand-built site is preserved at
[`/architecture-legacy/`](https://calimero-network.github.io/core/architecture-legacy/).
The docs live in [`docs/`](docs/) (Astro Starlight).

## Related Repositories

Expand Down
163 changes: 0 additions & 163 deletions architecture/abi-conformance.html

This file was deleted.

Loading