Skip to content

Provide a llms.txt #16049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wslyvh opened this issue May 14, 2025 · 1 comment
Open

Provide a llms.txt #16049

wslyvh opened this issue May 14, 2025 · 1 comment

Comments

@wslyvh
Copy link
Member

wslyvh commented May 14, 2025

What is the issue?

More people are using AI-based tools for development. In order to provide the best, up-to-date information I want to propose to provide a llms.txt that can be added as context in your prompts and development flow.

Most projects provide this as a public txt file at their main domain, e.g. soliditylang.org/llms.txt altho I would suggest this under the /.well-known/ subdir.

Especially for Solidity development, I think its important that generated code is correct, safe and uses recommended best practices. While it obviously provides no guarantees, I think having an up-to-date context for different major versions and compiler versions can helpful to provide a safe environment to experiment with AI-generated code

More info https://llmstxt.org/

Examples

@Sumitpalekar
Copy link

This is a great suggestion — thanks for raising it.

As someone who frequently works with AI-assisted development workflows and smart contract generation, I can say that the inclusion of an llms.txt file would be genuinely helpful. It would not only guide LLMs to produce safer and more up-to-date Solidity code, but also serve as a lightweight and effective way to align AI outputs with the best practices the Solidity team already promotes.

Given how rapidly tooling and compiler versions evolve, this kind of contextual signal can make a meaningful difference in code quality, especially for developers newer to the space who rely on AI-generated snippets. Hosting this under /.well-known/llms.txt seems like a clean and widely recognised approach.

I’d love to see the Solidity ecosystem take the lead on this — it’s a small step that could have significant impact in promoting safe and standardised smart contract development in AI-augmented environments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants