docs: add architecture explanation page - #335
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #335 +/- ##
=======================================
Coverage 53.38% 53.38%
=======================================
Files 14 14
Lines 871 871
=======================================
Hits 465 465
Misses 376 376
Partials 30 30
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This was referenced Jul 23, 2026
STRRL
marked this pull request as ready for review
July 23, 2026 06:40
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The architecture write-up (data flow, DNS management, connector reconciliation loop) lives only in
CLAUDE.mdand is not published on the docs site. The Explanation quadrant of the Divio documentation system is essentially empty. The docs site also has no Mermaid rendering support, which the new diagram-first documentation style requires.Part of #334.
Solution
Publish an architecture explanation page distilled from
CLAUDE.mdand verified against the actual sources, pointCLAUDE.mdat the published page, and add site-wide Mermaid rendering via the astro-mermaid integration.Major Changes
docs/src/content/docs/explanation/architecture.md(new)<tunnel-id>.cfargotunnel.com,_ctic_managed.<hostname>TXT ownership records,disable-dns-managementsemantics), plus prose on the 10s ControlledCloudflaredConnector reconciliation loop.astro-mermaidintegration added todocs/astro.config.mjsanddocs/package.json; any page's ```mermaid fence now renders as a diagram. The diagrams in the troubleshooting and how-to PRs depend on this, so merge this PR first.CLAUDE.mdNote: the sidebar entry for the new Explanation group is added in the upcoming sidebar reorganization PR; until then the page is reachable by direct URL.
Docs were written by Codex (gpt-5.6-sol) and reviewed for source accuracy by a separate review agent.