Add CLAUDE.md for Claude Code guidance #10345
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Provides build commands, testing instructions, architecture overview, and platform prerequisites to help Claude Code navigate the repository.
|
|
Member
|
Any thoughts about the more generic AGENTS.md? I'm not sure how standardised this area is as my hobby projects have ended up with |
Contributor
Author
|
I have no opinion on the matter, more generic is better. I guess we could (lol) ask the LLMs what the consensus is? |
Member
|
There is something else we (me?) failed to document. But you can use |
Contributor
Author
|
There doesn't seem to be a consensus way to do this yet, the other tools seem to also parse CLAUDE.md (and various other files). I'd say let's merge this and add mise into a more general file in docs/ that is linked from CLAUDE.md also? We can also extract more stuff into docs/building.md etc, if we want. The bigger question is, do we want this in the repo to help save tokens amongs users of Claude? |
Due to once being a seperate project the material docs duplicates some files. This fixes the main issues. Also fixes the readme that if followed to the letter would not have built the material docs.
Document CLI options, supported file types, and all syntax transformations with before/after examples.
Add supported elements table, document all converted properties, explain Figma variables support, and reorganize installation and development sections.
Document how the tool works, the CodeSnippetMD tag format with all attributes, CLI options, and build instructions.
Document CLI options, supported file types, and all syntax transformations with before/after examples.
Add supported elements table, document all converted properties, explain Figma variables support, and reorganize installation and development sections.
Explains the custom widget implementations (MdiWindow, Button, CheckBox, Slider, etc.) and UI patterns demonstrated.
Documents previously unlisted examples including fancy_demo, MCU examples, and platform integration examples.
Documents the differences between platform_native, platform_qt, and qt_viewer with use cases and comparison table.
…tion (slint-ui#10346) * Link to Astro Readme from development docs * Move Palette and StyleMetrics docs to own pages * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
We have currently a MSRV of rust 1.88 Some dependencies have minor versions update that needs a newer rust version, and Cargo will not automatically update to these dependencies because our workspace has that MSRV But our users might have a higher MSRV, and for them, Cargo will resolve the newer version of the crates. So add `--ignore-rust-version` in the CI to test with the newer versions for the newer compiler
The code that close the popup may delete the parents which may cause the `parent_item` expression to become invalid. Store its result before closing the popup. Fixes slint-ui#10293
…i#10368) Bumps the npm-patch-updates group with 2 updates: [@iconify-json/tabler](https://github.com/iconify/icon-sets) and [@biomejs/biome](https://github.com/biomejs/biome/tree/HEAD/packages/@biomejs/biome). Updates `@iconify-json/tabler` from 1.2.25 to 1.2.26 - [Commits](https://github.com/iconify/icon-sets/commits) Updates `@biomejs/biome` from 2.3.10 to 2.3.11 - [Release notes](https://github.com/biomejs/biome/releases) - [Changelog](https://github.com/biomejs/biome/blob/main/packages/@biomejs/biome/CHANGELOG.md) - [Commits](https://github.com/biomejs/biome/commits/@biomejs/[email protected]/packages/@biomejs/biome) --- updated-dependencies: - dependency-name: "@iconify-json/tabler" dependency-version: 1.2.26 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: npm-patch-updates - dependency-name: "@biomejs/biome" dependency-version: 2.3.11 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: npm-patch-updates ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…i#10367) Bumps the npm-minor-updates group with 1 update: [astro-embed](https://github.com/delucis/astro-embed/tree/HEAD/packages/astro-embed). Updates `astro-embed` from 0.9.2 to 0.10.0 - [Release notes](https://github.com/delucis/astro-embed/releases) - [Changelog](https://github.com/delucis/astro-embed/blob/main/packages/astro-embed/CHANGELOG.md) - [Commits](https://github.com/delucis/astro-embed/commits/[email protected]/packages/astro-embed) --- updated-dependencies: - dependency-name: astro-embed dependency-version: 0.10.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: npm-minor-updates ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This is an attempt to fix slint-ui#10278 by applying the recommendations of Olivier Goffart. Specifically, `LiveReloadingComponent::properties` and `LiveReloadingComponent::callback` are now placed into `RefCell` and the accessor methods are not changed to take `&self` instead of `&mut self` This doesn't appear to be a complete fix, as while this allows the specific example provided to load, attempts to change the Slint code "live" results in an unrelated `RefCell` issue. This of course defeats the purpose of Live Preview.
…uidance by `ogoffart`
This is only part of the overall if/for support in grid: for now it's only supported to repeat cells in a given row, one cannot repeat entire Rows this way yet. Some implementation notes: - GridLayoutOrganizedData (4 u16s per cell) can now contain indirection indices in the case of repeaters, like LayoutCache (2 f32s per cell). The "generator" for that is separate code due to these two differences (amount and type), while LayoutCacheAccess can be used for both (it now receives the additional information of how many entries per item, as a parameter) - BoxLayoutFunction and BoxLayoutCellData are used by the grid layouting code too; good for code sharing, but bad naming then. There are TODOs to rename those in a followup commit. This code reuse required porting from LayoutInfo to BoxLayoutCellData (which has only one field, the LayoutInfo, I suppose this is good for future extensions...). - Compared to handling of repeaters for box layouts, there are additional complications due to the "new_row" bool, especially with empty repeaters (the first item at compile time isn't necessarily the first item at runtime). The generated code solves that with a "running" new_row bool, to detect if the repeater had instances or not.
It's needed in GridLayoutElement for most of the layouting code, and in the Element for the case of repeated components. Only GridLayout's visit_rowcol_named_references() visits the Expressions, no need to do it again from Element, given that they're shared.
This reverts commit 70e102e. We decided in the API review to not re-export everything, but be more selective Conflicts: api/rs/slint/lib.rs internal/interpreter/api.rs
Reapply some part of 70e102e The idea is that the common things are re-exported from i_slint_core::api
* Docs: Add page for slint-lsp and slint-viewer * [autofix.ci] apply automated fixes * Use .webp instead of .png for assets * Remove unnecessary "simply" * Move editor documentation under docs/ * Use light theme in Neovim screenshot * Improve Neovim and Helix documentation * Move LSP documentation into docs. * Fix broken link * Add additional links between editors/ and docs/ * [autofix.ci] apply automated fixes * Improve structure of "Manual Setup" page * Use <Link/> for relative links * Remove duplicate heading * Fix spellcheck * Link to snapshot.slint.dev from repository * Move "Other Editors" tab higher in the menu --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
…0392) docsnapper only uses image::save_buffer() for PNG output, so it doesn't need the full set of image decoders enabled by default features.
The surface capabilities don't only list formats that are usable for render attachments. Since those formats should be available most of the time, pick either BGRA or RGBA from the list of supported formats. Fixes slint-ui#10233
Update tilde version in documentation with tilde version As in slint-ui#10394
Commit 598f145 added a translation for the layer but after the alignment, which needs to be swapped to still ensure pixel alignment for the layer.
Co-authored-by: Olivier Goffart <[email protected]>
This provides access to the shared fontique collection and permits registering custom fonts, replacing the previous custom wrappers.
With the `shared_` prefix, we emphasize that this is a shared collection. The docs now also include an example, the gallery code is adapted and simplified.
…of hardcoded values (slint-ui#10401) --------- Co-authored-by: Olivier Goffart <[email protected]>
Same reason why we can't do it with PopupWindow: the properties are in a different ItemTree and can't be accessed. This currently cause panic Fixes slint-ui#9443 CC slint-ui#9299
such as `reset` and `sort_model`, they should work regardless if the model was created with `new` or `new_ascending`
…n another thread Before this patch, if one try to use the platform from another thread than the thread in which the global context lives, we would first create the Platform in and then return an error that the platform is already set in another thread. But instead, we should check that it exist in another thread before creating the platform
- We were comparing the size of the item and not the source size - We were then using the the source rect in the original size coordinate and not the rendered size Fix slint-ui#10423
* Use aqua provider for ruff The default ruff provider returned a 404 and seems unmaintained. * Re-enable Aqua for all mise packages This seems to be working again
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
15 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Provides build commands, testing instructions, architecture overview, and platform prerequisites to help Claude Code navigate the repository.