Documentation
Documentation
Shared packages, UI primitives and operational recipes for this workspace.
What lives here
@isyuricunha/docs documents the reusable pieces of this monorepo: UI primitives, package recipes and the conventions that keep the website consistent.
The UI package is not a generic dark theme. It ships a warm Cursor-inspired token system, shared typography defaults, 0.5px borders, code styling, motion utilities and accessible primitives used by both the main site and the docs app.
The website recipes cover the public operating model for apps/web: localized content, SEO indexes, local-only translation generation and the validation gates used before deploy. They intentionally use placeholders for environment values and avoid documenting private service data.
Website recipes
- Website architecture explains the app/package boundaries and the public route families.
- Site translation explains the dev-only OpenAI-compatible translation generator and its batch profiles.
- SEO and indexing explains the sitemap, robots, RSS, metadata and crawler-facing files.
- Validation lists the commands that must pass before a release or commit.
Install
Use the preset
Theme contract
- Use
bg-bg-base,bg-bg-surface,text-text-primary,text-text-secondaryandtext-accent-earth-textinstead of raw color families. - Keep headings at
font-mediumor lower unless a single inline word needs emphasis. - Prefer editorial layouts, text links and app-window surfaces over generic icon-card feature grids.
- Use
label-mono,cta-link,app-window,cursor-cardandcursor-revealwhen building new surfaces.