External/beardrive

Fork 0

mirror of https://github.com/runbear-io/beardrive.git synced 2026-08-25 08:08:08 +02:00

Files

T

History

2b9beaf41a docs: architecture class diagrams + keep-updated-in-PRs workflow (#40 )

architecture/ holds mermaid class diagrams of the bdrive web server: the
Server core with its seams (Source, AuthProvider, Directory, QuotaProvider,
remote.Backend) and the MetaStore persistence layer.

Convention (CLAUDE.md): a PR that changes the drawn structure updates the
affected diagram in the same branch and embeds only the changed diagrams'
mermaid blocks in the PR description. A PreToolUse hook on gh pr create
(.claude/hooks/check-arch-diagrams.sh) blocks PR creation when
internal/webapp or internal/remote changed but architecture/ didn't;
override with '# skip-diagram-check' when nothing structural changed.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>

2026-07-22 15:23:18 -07:00

README.md

docs: architecture class diagrams + keep-updated-in-PRs workflow (#40 )

2026-07-22 15:23:18 -07:00

webapp-server.md

docs: architecture class diagrams + keep-updated-in-PRs workflow (#40 )

2026-07-22 15:23:18 -07:00

README.md

Architecture diagrams

Mermaid diagrams of the current implementation, kept next to the code so PRs can update them alongside the change.

Convention: when a PR changes the structure drawn here (new/removed types, new seams, changed relationships), update the affected diagram in the same PR and embed the changed diagrams' mermaid blocks in the PR description under an "Architecture changes" section, so reviewers see the structural delta. A pre-PR hook (.claude/hooks/check-arch-diagrams.sh) reminds Claude Code sessions when server code changed but no diagram did.

webapp-server.md — class diagram of the bdrive web server (internal/webapp + its internal/remote seam)