Architecture, module guide and reference, UI feature guide, design guidelines, kit reference and testing. Linked from the README Documentation section. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CCBUAC45JoSSgtjsRiSVnX
16 lines
937 B
Markdown
16 lines
937 B
Markdown
# FunPack documentation
|
|
|
|
For people who use FunPack, start with [How to start generating with FunPack](how-to-start.md).
|
|
|
|
For people who write code for it, read in this order:
|
|
|
|
1. [How FunPack is built](architecture.md): the idea, the layers, the failure model. Read this first.
|
|
2. [Writing a module](writing-a-module.md): a Python module, step by step, with a tested example.
|
|
3. [Module reference](module-reference.md): constants, setting keys, capabilities and helpers, in tables.
|
|
4. [Writing a UI feature](writing-a-ui-feature.md): a screen feature in the app, with a tested example.
|
|
5. [UI design guidelines](ui-design-guidelines.md): how the app looks and behaves, and the words it uses.
|
|
6. [UI kit reference](ui-kit-reference.md): every kit element, and how to add one.
|
|
7. [Testing and verification](testing.md): running the tests and what counts as proof.
|
|
|
|
If a page and the code disagree, the code is right. Please fix the page.
|