Repository navigation
In-app docs at /docs, Docs link in headers, README with architecture and screenshots - #10
Merged
Conversation
…itecture and screenshots Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 havebody,list,flow(numbered steps),table,code(with copy) andcallout. 29 pages;findDoc(path)returns{ page, prev, next }.app/app/docs/[section]/[page]/page.tsx:generateStaticParamsfromDOC_PAGES,dynamicParams = false(unknown paths 404), per-page metadata./docsredirects to/docs/start/introduction.components/docs/: desktop sidebar + collapsible mobile menu (aria-currenton the active page), section anchors, "On this page" TOC (xl+), previous/next links. Uses existing tokens,NoticeandButton; no new visual language.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.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