Skip to content

Shinro-xyz/studio-docs

Repository files navigation

Shinro Studio Documentation

Public documentation for Shinro Studio — the layer between firmware and application logic for robotics teams shipping on heterogeneous hardware. Hosted at docs.shinro.xyz.

Contributors: see CLAUDE.md for local dev, layout, and editorial principles.

Stack

Local development

pnpm install
pnpm dev      # http://localhost:4321
pnpm build    # production build into dist/
pnpm preview  # preview the production build

Deployment

Auto-deploys to docs.shinro.xyz via Vercel on push to main. See vercel.json for build configuration; the domain mapping itself is set in the Vercel project dashboard. The pnpm lockfile is committed — Vercel's pnpm install --frozen-lockfile depends on it.

Diagrams

Diagrams live under src/assets/diagrams/ as .png exports (with .excalidraw sources where available). They are produced externally with Excalidraw and committed alongside the docs. See src/assets/diagrams/README.md for the workflow.

License

MIT — see LICENSE.

Releases

No releases published

Packages

 
 
 

Contributors