Skip to content

Conversation

@tilladam
Copy link
Contributor

@tilladam tilladam commented Jan 2, 2026

Provides build commands, testing instructions, architecture overview, and platform prerequisites to help Claude Code navigate the repository.

@CLAassistant
Copy link

CLAassistant commented Jan 2, 2026

CLA assistant check
All committers have signed the CLA.

@NigelBreslaw
Copy link
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 .cursorrules and AI_INSTRUCTIONS.md.

@tilladam
Copy link
Contributor Author

tilladam commented Jan 5, 2026

I have no opinion on the matter, more generic is better. I guess we could (lol) ask the LLMs what the consensus is?

@NigelBreslaw
Copy link
Member

There is something else we (me?) failed to document. But you can use mise within the monorepo and it will download and install quite a few tools and the correct rust compiler, but only within the monorepo itself. It won't mess with your entire machines dev environment. So the AGENTS.md text could have something like "Install Mise. On MacOS brew install mise. Then mise install to set it up. When making changes as part of verifying they work run mise run 'ci:autofix:fix'". Which runs the same autofix task as the Slint CI, but locally."

@tilladam
Copy link
Contributor Author

tilladam commented Jan 5, 2026

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?

@tronical
Copy link
Member

Olivier and I discussed this. We don't mind an AGENTS.md file in the top-level, but it could also go into another directory if suitable. It seems valuable to have something like this and the continue refining it as the tooling evolves.

This PR needs a rebase so that only the newly added file shows up in the diff.

Copy link
Member

@tronical tronical left a comment

Choose a reason for hiding this comment

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

(GH requires a comment when giving a review)

@NigelBreslaw
Copy link
Member

It's the root or not at all. Part of requesting 'AGENTS' instead of CLUADE was too minimise it to a single file and not one for each flavour of the month LLM.

@tronical
Copy link
Member

Yep, top-level (root) is fine with Olivier and me. Whatever works :)

Provides build commands, testing instructions, architecture overview,
and platform prerequisites to help Claude Code navigate the repository.
- Rename header from CLAUDE.md to AGENTS.md
- Add missing internal components (core-macros, common)
- Add missing backends (selector, testing)
- Add missing tools (slintpad, figma_import, tr-extractor, updater)
- Add wasm-interpreter API
- Add new Editor Support section with all editor integrations
@tilladam tilladam force-pushed the add-claudemd-to-repo branch from e09d541 to d75eb90 Compare January 22, 2026 10:46
Co-authored-by: Simon Hausmann <[email protected]>
@tronical tronical merged commit 6d0a3b4 into slint-ui:master Jan 22, 2026
27 of 34 checks passed
@tilladam tilladam deleted the add-claudemd-to-repo branch January 22, 2026 11:09
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.

4 participants