docs(#6307): add mintcore contributor guide - #6515
Conversation
Add docs/contributing/mintcore.md documenting the shipped mintcore architecture: deploy targets and load sites, platform accessors (mintEnv, mintHTTP), load-site construction pattern, WASM-safe and WASM-unsafe patterns, PEM injection model, interfaces vs accessors, embed sync rules, and explicitly rejected patterns (niladic factories, wire_*.go, mintPEM, NewPlatformHandler). Link the guide from AGENTS.md topic-specific guidance table and from docs/architecture.md (standalone mint deployment bullet). docs/contributing/go-code.md WASM section already covers the accessor and load-site construction invariants consistently — no changes needed. Closes #6307
Site previewPreview: https://2ad411d8-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 9:33 AM UTC · Completed 9:50 AM UTC Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Previous runReviewFindingsMedium
Previous run (2)ReviewFindingsMedium
Low
|
|
/fs-fix |
|
🤖 Finished Fix · ✅ Success · Started 9:55 AM UTC · Completed 10:01 AM UTC Commit: |
- Fix layering diagram in mintcore.md: split internal/dispatch/cf/ and internal/dispatch/gcf/ into separate top-level entries (they are sibling directories, not nested) - Update gcfSkip count in go-code.md from three to five entries, adding env_js.go and http_client_js.go to match provisioner_test.go - Remove preamble paragraph from mintcore.md to match convention of other docs/contributing/ files (scope is in AGENTS.md table) Addresses review feedback on #6515
🔧 Fix agent — iteration 1 (human-triggered)Addressed all 4 review findings: fixed the layering diagram path nesting, updated gcfSkip count from 3 to 5 in go-code.md, removed non-standard preamble from mintcore.md, and acknowledged the protected-path informational finding (no code fix needed — human approval is a separate process). Fixed (3):
Disagreed (1):
Tests: passedNext steps:
|
|
🤖 Finished Review · ✅ Success · Started 10:03 AM UTC · Completed 10:16 AM UTC Commit: |
|
/fs-fix drop mentions about unused/dropped patterns like niliadic factories |
|
🤖 Finished Fix · ✅ Success · Started 10:49 AM UTC · Completed 10:56 AM UTC Commit: |
Remove sections documenting rejected/unimplemented patterns (niliadic *FromEnv factories, threading http.Client, wire_*.go, mintPEM/RegisterPEM, and the "Rejected patterns" summary table). These describe historical design decisions that were never shipped and add noise for contributors reading the guide for orientation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🔧 Fix agent — iteration 2 (human-triggered)Addressed human instruction to drop mentions of unused/dropped patterns like niliadic factories from the mintcore contributor guide. Removed all sections that documented historical design decisions that were never shipped (niliadic FromEnv factories, threading http.Client, wire_.go/NewPlatformHandler, mintPEM/RegisterPEM) and the 'Rejected patterns' summary table. The guide now focuses exclusively on the shipped architecture. Fixed (1):
Tests: passedNext steps:
|
|
🤖 Finished Review · ✅ Success · Started 10:58 AM UTC · Completed 11:17 AM UTC Commit: |
|
🤖 Finished Retro · ✅ Success · Started 7:46 PM UTC · Completed 7:59 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $5.36 |
Retro: PR #6515 — docs(#6307): add mintcore contributor guideWorkflow overview: A docs-only PR adding Timeline
What went well
Evidence for existing issues
Proposals filed
|
Summary
docs/contributing/mintcore.md— a contributor guide documenting the shipped mintcore architecture (platform accessors, load-site construction, WASM-safe wiring, and rejected patterns)AGENTS.mdtopic-specific guidance table and fromdocs/architecture.md(standalone mint deployment section)docs/contributing/go-code.mdWASM section already covers the accessor invariants consistently — no changes neededDetails
The guide covers:
internal/mintcore/vs entrypoints vs CF Worker TypeScript adaptermintEnv,mintHTTP; build-tagged implementations;RegisterEnv/RegisterHTTPon WASMOIDCVerifier+PEMAccessorand callsNewHandler(pem, verifier)mintHTTP, niladic*FromEnvfactories, threadinghttp.ClientRegister*at bootstrap, plain-data configs, request-timemintHTTP(req)FilesystemPEMAccessor/GCPSecretPEMAccessor/HostPEMAccessormake wasm-build— new file checklist,gcfSkip, gzip size gatewire_*.go,mintPEM,NewPlatformHandler()as rejected (not TODO)Testing
lycheeoffline link check passed (0 errors across all changed files)lint-docs-linkspassedscan-secretspassedgitlintpassedCloses #6307
Post-script verification
agent/6307-mintcore-contributor-guide)c6e147139de3d787167799e15fcb5f7222674bd0..HEAD)