Guides
Use Guides when you already know the outcome you want and need the shortest correct path to it: brand the tokens, choose a density, own the source, upgrade safely, fix a specific error, or build a table or a date picker properly the first time.
Every guide leads with the answer and puts the evidence underneath it.
Prerequisites: BeeUI already installed and running per Start — Guides assume a working app, not a fresh install.
Make it yours
Section titled “Make it yours”| Guide | Use it when |
|---|---|
| Branding | You need your own palette behind BeeUI’s semantic tokens, without forking component source. |
| Density | You need compact, comfortable or spacious layout metrics, and need to know how density composes with theme and responsive behavior. |
Own and evolve the code
Section titled “Own and evolve the code”| Guide | Use it when |
|---|---|
| CLI & source ownership | You want the component source inside your repository, and need the exact init / add / doctor / diff / update contract. |
| Migration & versioning | You need to know which channel you are on, what the version number means, and what a future upgrade will and will not do to your code. |
| Current release | You need the exact version, channel and distribution state this documentation was generated from. Generated, not hand-written. |
Build specific surfaces
Section titled “Build specific surfaces”| Guide | Use it when |
|---|---|
| Table | You are building a sortable, selectable, responsive data table and need the state-ownership and performance envelope up front. |
| Date & time | You are picking or storing dates and want the timezone, locale, week-start and DST rules before you write the first value. |
When something is wrong
Section titled “When something is wrong”| Guide | Use it when |
|---|---|
| Troubleshooting | You have an exact error string, a build that fails, or a screen that renders unstyled. Search the page for your literal console output. |
Guides, Learn, and Reference
Section titled “Guides, Learn, and Reference”BeeUI splits documentation by the question you are asking:
| Section | Question it answers | Shape |
|---|---|---|
| Start | “How do I get BeeUI running at all?” | A first-success path per platform. |
| Guides | “How do I accomplish this task correctly?” | Goal → action → behavior matrix → limitation → evidence. |
| Learn | “Why is it built this way, and what does that mean for my architecture?” | Concepts and boundaries, not procedures. |
| Reference | “What is the exact fact?” | Generated or mechanically-checked contracts — props, types, tokens, tested versions. |
If a guide and a generated reference page disagree, the generated page wins: it is derived from source, and this section is not. Report the guide as the defect.
Related
Section titled “Related”- Theming — the semantic token contract that Branding and Density build on.
- Components — the per-component reference surface.
- Patterns — production screen compositions.
- Compatibility — tested versions versus promised peer ranges.
- Accessibility — the behavior contract every guide assumes.