slint-ui / slint

Slint is a declarative GUI toolkit to build native user interfaces for Rust, C++, or JavaScript apps.

https://slint.dev

Other

17.66k stars 611 forks source link

Tracking issue for Docs update #6233

Open NigelBreslaw opened 2 months ago

NigelBreslaw commented 2 months ago

Docs

Main page is the current "docs/slint"
Use the per language tabs in the slint language documentation
Base the docs structure from Flutter

Structure

Get started
- Setting up (install dependencies, or the extension, ...)
  - Rust Win / Linux / Mac
  - C++ Win / Linux / Mac
  - ...
  - ...
  - (supported platforms)
- quick start
- (Moving from another platform)
Concepts
- Slint as a UI language (philosophy)
- Components / Elements
- Reactive Programming (data flowing through properties, created by bindings (properties, purity, lazyness))
- Data Models
- Positioning and Layout of Elements
- Focus Handling
- Translations
- Animations
- States & Transitions
- Functions
- Accessibility
- Name resolution (Scoping) (currently under function)
Reference
- Syntax (.slint file Comments, Identifiers, declaring functions,statemens, struct and enums)
- Primitive Types
- Common properties / callbacks
- Common geometry properties
- Builtin elements (one page per element)
- Global Enumerations (move other enums to the page of their respective elements/types)
- Global Functions and Builtin Namespaces
- Keyboard Types & Enums
- Color Types & Functions
- Accessibility Properties and Callbacks
- Layouts (elements, common properties)
  - Geometry properties
    - x, y, ...
  - Layout Elements
    - HorizontalLayout
    - VerticalLayout
    - GridLayout
- Standard Widgets (same categories as what we put in the design editors)
  - Layout Widgets
  - Text Widgets
  - Views
  - Input Controls
  - (one page per widget)
- Programming language APIs
  - C++ API
  - Rust API
  - JS API
  - Python

Reciepes and examples
advanced topics (maybe see they go to concepts or if some concepts go there)

Action points

[x] We make a feature branch for the structure (decouple from 1.8)
[x] Simon and Nigel to have a call to get a start of it (completed)

NigelBreslaw commented 2 months ago

Anyway to just show the major versions? Who needs more than '1.5'? 1.5.0, 1.5.1, etc should not exist for docs??

Screenshot 2024-09-25 at 13 28 15