Skip to content

Remove legacy architecture HTML docs, consolidate to Starlight#3012

Open
chefsale wants to merge 2 commits into
masterfrom
claude/consolidate-docs-folders-0wxemt
Open

Remove legacy architecture HTML docs, consolidate to Starlight#3012
chefsale wants to merge 2 commits into
masterfrom
claude/consolidate-docs-folders-0wxemt

Conversation

@chefsale

Copy link
Copy Markdown
Member

Description

This PR removes the legacy static HTML architecture documentation (architecture/ directory) and consolidates all documentation into the Starlight-based docs site. The HTML docs have been superseded by the Markdown-based documentation in docs/src/content/docs/.

Changes:

  • Removed 40+ HTML files from architecture/ directory (migrations, glossary, auto-follow, sync engine, error flows, SDK, config reference, context, governance, tools, storage, node, server, metrics, network, dependency explorer, nav.js, and protocol subdirectory)
  • Removed legacy GitHub Actions workflow for HTML docs deployment (.github/workflows/pages.yml)
  • Updated workflow configurations to remove references to legacy docs
  • Updated .ai-reviewer.yaml to remove doc auto-update rules for removed files
  • Updated README.md to reflect documentation consolidation
  • Reorganized docs-site/docs/ with all Starlight content preserved

Rationale:
The Starlight documentation site provides a modern, maintainable alternative with better search, navigation, and integration with the development workflow. The legacy HTML docs were manually maintained and difficult to keep in sync with code changes.

Test plan

N/A — This is a documentation consolidation with no functional code changes. The Starlight docs site is already deployed and tested via existing CI workflows (docs-site.yml and docs-ci.yml).

Documentation update

All documentation has been migrated to the Starlight site at docs/src/content/docs/. No additional updates needed.

https://claude.ai/code/session_01QPfVBkQdnWk8ksrUQ8ayPU

…e/ to docs/

The Astro Starlight site (formerly docs-site/) is now the single home for
documentation, published to GitHub Pages. Remove the superseded legacy
hand-built architecture/ HTML site and the old docs/ folder (ADRs, design
docs, documentation roadmap), and rename docs-site/ to docs/.

- Delete architecture/ (legacy site) and docs/ (adr, design, roadmap).
- git mv docs-site/ -> docs/.
- Workflows: drop obsolete pages.yml (architecture/ deploy); repoint
  docs-site.yml and docs-ci.yml at docs/ and remove the architecture-legacy
  bundling/triggers; strip architecture/ from doc-update and ai-review
  paths-ignore.
- .ai-reviewer.yaml: remove the architecture/ static_docs_dirs and the
  source_to_docs_mapping pointing at deleted architecture/*.html pages.
- README + docs site content: repoint docs-site/ references to docs/ and
  drop links to the removed ADR page, architecture-legacy site, and roadmap.
- Source doc-comments: strip now-dead references to architecture/*.html and
  docs/adr/*.md; point the SDK migrations note at the published docs page.

Verified: `npm run check` (astro build + internal link check) passes.
@cursor

cursor Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Bugbot is paused — on-demand spend limit reached

Bugbot uses usage-based billing for this team and has hit its on-demand spend limit.

A team admin can raise the spend limit in the Cursor dashboard, or wait for the next billing cycle to continue.

@github-actions

Copy link
Copy Markdown

Your PR title does not adhere to the Conventional Commits convention:

<type>(<scope>): <subject>

Common errors to avoid:

  1. The title must be in lower case.
  2. Allowed type values are: build, ci, docs, feat, fix, perf, refactor, test.

@meroreviewer meroreviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 MeroReviewer

Reviewed by 1 agents | Quality score: 32% | Review time: 122.4s

💡 2 suggestions. See inline comments.


🤖 Generated by MeroReviewer | Review ID: review-8706296c

Comment thread docs/src/content/docs/build/permissioned-storage.mdx
Comment thread crates/storage/src/rotation_log.rs Outdated
@meroreviewer

meroreviewer Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Documentation Review

The following documentation may need updates based on the changes in this PR:

  • 🟡 AGENTS.md: AGENTS.md exists but was not updated — consider updating it to reflect the architecture changes in this PR.
  • 🟡 CONTRIBUTING.md: CONTRIBUTING.md exists but was not updated — consider updating it to reflect the architecture changes in this PR.
  • 🟡 docs/: Static HTML docs in docs/ may need updating — architecture-impacting changes detected. On merge, update-docs will scan this directory and open a PR if any pages need to change.

The ADR that documented the writer-set merge rule was removed in this PR's
folder consolidation. Inline the per-level rationale (causal-first / HLC /
signer-pubkey) in the module doc and point to the published Permissioned
Storage docs page so the 'why' survives.

@frdomovic frdomovic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving — effectively a docs-only consolidation: removes ~24.8k lines of legacy architecture/*.html + JS/CSS, renames docs-site/docs/ (Starlight), and deletes some stale ADR/design .md. The 12 touched crates/** files are all comment/doc-comment-only edits (dropping references to deleted HTML/ADRs) — no logic, signature, or behavior changes. All CI/deploy/README references were updated consistently; an orphaned-reference scan found zero broken links.

⚠️ Two non-code items:

  • The PR is currently CONFLICTING / DIRTY — needs a rebase against master before it can merge.
  • Several ADR/design markdown files are deleted outright, not migrated (docs/adr/0001-*, 0002-*, calimero-components.md, the unified-causal-log-* docs, etc.). Nothing links to them anymore, but if that content was meant to live on as reference, it's gone rather than moved. Confirm the loss is intentional.

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

This pull request has been automatically marked as stale. If this pull request is still relevant, please leave any comment (for example, "bump"), and we'll keep it open. We are sorry that we haven't been able to prioritize reviewing it yet. Your contribution is very much appreciated.

@github-actions github-actions Bot added the Stale label Jul 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants