Skip to content

docs: add design rationale (strengths + alternatives) - #84

Merged
ababic merged 1 commit into
mainfrom
cursor/design-rationale-docs-5d65
Aug 14, 2026
Merged

ababic merged 1 commit into
mainfrom
cursor/design-rationale-docs-5d65

Conversation

@ababic

@ababic ababic commented Aug 14, 2026

Copy link
Copy Markdown
Owner

Summary

Adds a new Design rationale page to the mdBook docs that:

  • Explains Dumpling’s design pillars (fail-closed, streaming, domains, policy-as-data, CI gates, offline)
  • Contrasts alternative approaches (live DB anonymization, dynamic masking, ad-hoc scripts, app-level faking, commercial platforms, fully random replacement) and why the file-based model wins for dump/CI workflows
  • Tours codebase strengths in plain language
  • Documents intentional non-goals and a high-level runtime pipeline

Also links the page from SUMMARY.md and the docs overview.

Test plan

  • mdbook build succeeds
  • docs/book/design-rationale.html is generated with expected section headings
Open in Web Open in Cursor 

Explain why Dumpling is file-based and fail-closed, contrast live DB
masking, scripts, and commercial platforms, and tour codebase strengths.

Co-authored-by: andy <andy@wearecrew.com>
@ababic
ababic marked this pull request as ready for review August 14, 2026 16:46
@ababic
ababic merged commit 2a39668 into main Aug 14, 2026
10 checks passed
@ababic
ababic deleted the cursor/design-rationale-docs-5d65 branch August 14, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants