Overview
Purpose and scope of the Ziteox Forge platform.
Ziteox Forge — Overview
Ziteox Forge is the internal development platform shared across Ziteox projects. It centralizes reusable code, conventions, and tooling so product applications stay consistent and maintainable.
Purpose
Forge exists to:
- Share UI components across Ziteox apps without copy-paste
- Encode architecture decisions once (domains, animation strategy, naming)
- Reduce integration cost for new projects through documented APIs and examples
- Support human and AI-assisted development with explicit, structured documentation
Forge is a monorepo, not a single application. Packages are consumed by Ziteox product repos via workspace linking or package registry.
Current scope
| Area | Location | Status |
|---|---|---|
| UI library | packages/ui (@ziteox/ui) | Active — theme, navigation, branding domains |
| Playground | examples/playground | Local dev/demo app |
| Agents | agents/ | Reserved |
| Prompts | prompts/ | Reserved |
| Standards | standards/ + docs/standards/ | In progress |
| Examples | examples/ | Playground only |
Packages
@ziteox/ui
React component library. Domain-organized source under packages/ui/src/.
Public domains today:
| Domain | Components |
|---|---|
theme | ThemeProvider, ThemeToggle, AnimatedThemeToggler |
navigation | HamburgerButton |
branding | BrandCredit |
Documentation map
| Document | Audience | Contents |
|---|---|---|
| overview.md | All | Platform purpose and scope |
| architecture.md | Engineers, agents | Monorepo layout, build, exports |
| getting-started.md | Engineers | Install, configure, first integration |
| ui/*.md | Engineers, agents | Per-component API and examples |
| standards/*.md | Contributors | Conventions for new work |
The website at apps/docs renders this docs/ folder directly. Run pnpm dev from the monorepo root to preview locally.
Conventions for readers (including AI agents)
- Paths are relative to the
ziteox-forgerepository root unless stated otherwise. - Public API means exported from
packages/ui/src/index.tsor a domain subpath (@ziteox/ui/theme, etc.). - Internal modules (
shared/,animations/) are not part of the public contract. - When implementing features, read domain-boundaries.md before adding files.
Related directories (not documented here yet)
agents/— agent workflows and automationprompts/— shared prompt templatesstandards/— repo-level standards (non-markdown sources, if any)