-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Home
Astryx is a design system for building internal tools. This wiki documents the architecture, the conventions, and the protocols behind it.
Each section below links the pages you need first. The deeper material is linked from those pages, not from here.
- Astryx Philosophy — Why Astryx exists, what we learned, and the principles that emerged
- Contributing with AI Assistants — How to contribute with Navi or another AI assistant. Start here if you're new.
- Contributing — How contributions work, what we accept, the RFC process, and what to expect
- System Architecture — Customization layers, tokens, AI-native design
- Architecture Cheat Sheet — Minimal component template and shared-system lookup for authors and reviewers
-
Theming Infrastructure —
defineTheme, CSS custom properties, layer ordering, subcomponent overrides - Distribution — Packages, versioning, source and dist bundles, pre-compiled CSS
Deeper: Container Padding System · Chart System Architecture · Docsite Architecture · Why StyleX · RSC Compatibility
- Component Lifecycle — The end-to-end guide: specification → build → hardening → maintenance. The individual protocols are linked from it.
- Component Authoring Guide — File structure, StyleX patterns, token usage, and conventions
- API Conventions — Naming, props, composition, and styling conventions for all components
- Design Conventions — Visual and interaction conventions: the intention behind token choices, state representations, and how design quality is evaluated
- Component Audit Rubric — The graded checklist: eleven weighted sections and what counts as evidence. Reviewing a PR? Its guidance on reviewing a change sets the bar by change type and never runs the whole checklist on a diff.
- Accessibility Checklist — The ten-item accessibility bar; a hard requirement for graduating a component to core
- Release Process — Changesets, codemods, version bumps, publishing
- Night Watch Overview — Automated repo stewardship during off-hours; the roles are linked from it
Vibe Tests — the three vibe-testing workflows · Contributing Templates — full-page templates for the sandbox and CLI · Research Archive — historical explorations and forward-looking research
Note: For component-specific documentation, see the
{Name}.doc.mjsfile in each component's directory underpackages/core/src/. Runastryx component <Name>to view formatted docs.
Start here Astryx Philosophy Contributing with AI Assistants Contributing
Architecture System Architecture Architecture Cheat Sheet Theming Infrastructure Distribution
Building a component Component Lifecycle Component Authoring Guide API Conventions Design Conventions
Quality Component Audit Rubric Accessibility Checklist
Operations Release Process Night Watch Overview