Skip to content

docs: expand architecture and release documentation#173

Merged
BunsDev merged 3 commits intomainfrom
docs/update-comprehensive-readmes
Apr 1, 2026
Merged

docs: expand architecture and release documentation#173
BunsDev merged 3 commits intomainfrom
docs/update-comprehensive-readmes

Conversation

@BunsDev
Copy link
Copy Markdown
Contributor

@BunsDev BunsDev commented Apr 1, 2026

Summary

This PR is a documentation and release-operations cleanup focused on:

  • Expanded architecture and onboarding docs in the root README.md.
  • Formalized release playbook and triage in docs/releases/README.md.
  • Added Vercel deployment troubleshooting for missing .next output/publish version pitfalls.
  • Updated mobile SPM documentation in apps/mobile/ios/App/CapApp-SPM/README.md.

It also includes cleanup for formatting/lint/type on affected files in marketing/web to keep the branch green.

Commits

  • Single squashed commit: 66256c77

What changed

1) Architecture + onboarding docs (README.md)

  • Added explicit architecture flow and module responsibilities.
  • Added runtime flow, package map, and local setup matrix.
  • Added quality gate / release / operations checklists.

2) Release process docs (docs/releases/README.md)

  • Broken out CI stages and matrix expectations.
  • Added required release artifacts checklist.
  • Added operational matrix for common failures and recovery.
  • Added Vercel-specific failure triage:
    • missing output directory .next
    • publish version reuse errors

3) Vercel config hardening (vercel.json)

  • Set Next framework explicitly.
  • Scoped build/dev commands to apps/marketing.
  • Kept output directory to apps/marketing/.next to prevent missing-output errors in monorepo builds.

4) iOS SPM docs (apps/mobile/ios/App/CapApp-SPM/README.md)

  • Added package purpose, install, regeneration, and troubleshooting guidance.

Validation

  • bun run lint
  • bun run fmt:check
  • bun run typecheck
  • bun run test
  • bun run build:marketing (verified apps/marketing/.next exists)

Notes

  • Prior non-blocking log errors were from publish/version state and are outside runtime/docs scope.
  • This PR is now squashed into one commit for easier review.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
okcode-marketing Error Error Apr 1, 2026 11:07am
v0-compute-the-platform-to-build Ready Ready Preview, Open in v0 Apr 1, 2026 11:07am

@github-actions github-actions bot added size:XL vouch:trusted PR author is trusted by repo permissions or the VOUCHED list. labels Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XL vouch:trusted PR author is trusted by repo permissions or the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant