Ziteox Forge

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

AreaLocationStatus
UI librarypackages/ui (@ziteox/ui)Active — theme, navigation, branding domains
Playgroundexamples/playgroundLocal dev/demo app
Agentsagents/Reserved
Promptsprompts/Reserved
Standardsstandards/ + docs/standards/In progress
Examplesexamples/Playground only

Packages

@ziteox/ui

React component library. Domain-organized source under packages/ui/src/.

Public domains today:

DomainComponents
themeThemeProvider, ThemeToggle, AnimatedThemeToggler
navigationHamburgerButton
brandingBrandCredit

Documentation map

DocumentAudienceContents
overview.mdAllPlatform purpose and scope
architecture.mdEngineers, agentsMonorepo layout, build, exports
getting-started.mdEngineersInstall, configure, first integration
ui/*.mdEngineers, agentsPer-component API and examples
standards/*.mdContributorsConventions 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-forge repository root unless stated otherwise.
  • Public API means exported from packages/ui/src/index.ts or 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.
  • agents/ — agent workflows and automation
  • prompts/ — shared prompt templates
  • standards/ — repo-level standards (non-markdown sources, if any)