TUWA Docs

TUWA Docs is the documentation gateway of the TUWA ecosystem: the docs hub, where every TUWA project starts and where the guides that combine several projects live, and @tuwaio/docs-ui, the shared UI of all TUWA documentation sites.

📖 Docs hub: docs.tuwa.io

---

🏛️ Place in the TUWA Documentation

TUWA documents each kind of content in one place:

Site	Content
docs.tuwa.io (this repository)	The ecosystem map with a card for every project, the guides (architecture deep dives and step-by-step setups that combine several projects) and the Quasar docs
orbit.docs.tuwa.io, siwx.docs.tuwa.io, satellite.docs.tuwa.io, pulsar.docs.tuwa.io, sdk.docs.tuwa.io	One project each: an Introduction, the package READMEs and a reference of every export generated from the source
stories.tuwa.io	Nova UI Kit: the components, theming and the package reference in Storybook

A guide that needs only one package belongs on the site of that package; a guide that combines several projects belongs here.

---

🔧 Monorepo Structure

docs/
├── apps/
│   └── docs-hub/               # docs.tuwa.io (Next.js 16 + Nextra 4)
│       ├── src/app/            # Main screen (React), the /guides and /quasar routes (Nextra)
│       ├── src/components/     # Main screen: hero, layer timeline, quick start
│       ├── src/content/        # The guides and the Quasar docs (MDX)
│       └── public/             # quasar-openapi.yaml, generated by `pnpm openapi:gen` in TuwaIO/quasar-client
└── packages/
    └── docs-ui/                # @tuwaio/docs-ui: navbar, footer, logo, theme switch, stylesheet

• apps/docs-hub: the hub. See its README for local development and for adding a project or a guide.
• @tuwaio/docs-ui: published to npm and used by every TUWA documentation site, the hub, the landing page and the Quasar dashboards. Peer dependencies: react; next, nextra and nextra-theme-docs are optional (the /nextra entries).

---

🛠️ Development

pnpm install     # installs dependencies and builds @tuwaio/docs-ui
pnpm build       # builds @tuwaio/docs-ui with tsup and PostCSS
pnpm lint        # runs ESLint
pnpm format      # runs Prettier
pnpm dev:hub     # runs the docs hub on http://localhost:3000
pnpm build:hub   # builds the docs hub and its Pagefind search index

The hub uses the local @tuwaio/docs-ui (workspace:*); the other TUWA sites use the version published to npm.

---

🤝 Contribution & Auditing

Please review our ecosystem Contribution Guidelines.

📄 License

Licensed under the Apache-2.0 License. See the LICENSE file for details.