Skip to content

Make "agents" documentation available to humans too#10832

Open
dfaure-kdab wants to merge 2 commits intoslint-ui:masterfrom
dfaure-kdab:wip/dfaure/agents-doc-for-humans
Open

Make "agents" documentation available to humans too#10832
dfaure-kdab wants to merge 2 commits intoslint-ui:masterfrom
dfaure-kdab:wip/dfaure/agents-doc-for-humans

Conversation

@dfaure-kdab
Copy link
Collaborator

Followup to #10831

Copy link
Collaborator

@LeonMatthes LeonMatthes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good that this is deduplicated. Documentation for agents should be useful for devs also 👍
The exact file list feels like it will get outdated quickly though.
Other than that we can merge this.

Comment on lines 114 to 128
## More detailed documentation for slint contributors

- **`docs/development/compiler-internals.md`** - Compiler pipeline, passes, LLR, code generation.
- **`docs/development/type-system.md`** - Type definitions, unit types, type conversions, name resolution, type register.
- **`docs/development/property-binding-deep-dive.md`** - Reactive property system, dependency tracking, two-way bindings, PropertyTracker, ChangeTracker.
- **`docs/development/custom-renderer.md`** - Renderer traits, drawing API, backend integration, testing.
- **`docs/development/animation-internals.md`** - Animation timing, easing curves, performance, debugging.
- **`docs/development/layout-system.md`** - Layout solving, constraints, compile-time lowering.
- **`docs/development/item-tree.md`** - Item tree structure, component instantiation, traversal, focus, event handling.
- **`docs/development/model-repeater-system.md`** - Model trait, VecModel, adapters (map/filter/sort), Repeater, ListView virtualization, `for` loops, `if` statements.
- **`docs/development/input-event-system.md`** - Mouse/touch/keyboard events, event routing, focus management, drag-drop, shortcuts.
- **`docs/development/text-layout.md`** - Text shaping, line breaking, paragraph layout, styled text parsing, text rendering.
- **`docs/development/window-backend-integration.md`** - WindowAdapter trait, Platform trait, WindowEvent, popup management, backend implementations.
- **`docs/development/lsp-architecture.md`** - LSP server, code completion, hover, semantic tokens, live preview, IDE tooling.
- **`docs/development/ffi-language-bindings.md`** - C++/Node.js/Python bindings, cbindgen, FFI patterns, adding new cross-language APIs.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this list will get outdated very quickly, just pointing people towards "for more details see the docs/development" should be good enough IMO.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yeah that would work too. We're not really clicking on links here anyway, if we're reading this from an IDE or terminal.

@dfaure-kdab dfaure-kdab force-pushed the wip/dfaure/agents-doc-for-humans branch from 6a37014 to 0d09607 Compare February 20, 2026 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments