Skip to content

In-app docs at /docs, Docs link in headers, README with architecture and screenshots - #10

Merged
devin-ai-integration[bot] merged 1 commit into
mainfrom
devin/1791051212-docs-readme
Oct 3, 2026
Merged

devin-ai-integration[bot] merged 1 commit into
mainfrom
devin/1791051212-docs-readme

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Adds official Setlo documentation inside the frontend, following the Notion "Reusable Docs Site Architecture" (Start → Using Setlo → Architecture → Reference → Security → Proof → Help), and rewrites the root README.

Docs shell (data-driven, statically generated)

  • app/lib/docs.ts: DOC_PAGES: DocPage[] ({ group, path, title, description, sections: DocSection[] }), where a section can have body, list, flow (numbered steps), table, code (with copy) and callout. 29 pages; findDoc(path) returns { page, prev, next }.
  • app/app/docs/[section]/[page]/page.tsx: generateStaticParams from DOC_PAGES, dynamicParams = false (unknown paths 404), per-page metadata. /docs redirects to /docs/start/introduction.
  • components/docs/: desktop sidebar + collapsible mobile menu (aria-current on the active page), section anchors, "On this page" TOC (xl+), previous/next links. Uses existing tokens, Notice and Button; no new visual language.
  • Content is taken from the current code and contract (e.g. the relayer whitelist, requiredFunding, _extendDeadlines, friendly() error messages), and only describes live behaviour. Limitations and testnet scope are on their own page.

Docs link added to the landing header, the authenticated app header (hidden below sm, like "Bookings", so the mobile header doesn't overflow), the demo and legal page headers, and the footer's Product column.

README: what Setlo is, the problem, the 5-step flow, a mermaid architecture diagram, a component table, the lifecycle and money-by-transition table, trust boundaries, deployments (both Sourcify exact-match verified, checked today), repo layout, local run and CI commands, evidence and limitations. Screenshots in docs/screenshots/ come from a local production build of public pages only (landing, docs, demo, docs on mobile), so no account data is shown.

Checked: pnpm typecheck, lint, test, build (all 29 docs pages prerendered); I also looked at the desktop and 390px pages in Chrome.

Docs
Docs on mobile

Link to Devin session: https://app.devin.ai/sessions/dc532fa9edf5401189dae9b7e6c5259c
Open in Devin Desktop: https://app.devin.ai/desktop/session/dc532fa9edf5401189dae9b7e6c5259c?variant=devin
Requested by: @CryptoZephyr

…itecture and screenshots

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

@vercel

vercel Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
setlo Ready Ready Preview Oct 3, 2026 6:30pm UTC

@devin-ai-integration
devin-ai-integration Bot merged commit b1dcab0 into main Oct 3, 2026
4 checks passed

This branch was successfully deployed

1 active deployment
Preview — 7437f554 Deployed Oct 3, 2026 by vercel[bot]
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.

1 participant