Skip to content

Improve llms-full.txt by adding API references and adding compact version of the docs #147

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
aglitchman opened this issue Mar 30, 2025 · 4 comments

Comments

@aglitchman
Copy link
Contributor

aglitchman commented Mar 30, 2025

After reading this discussion, I realised that 200K+ tokens in the current llms-full.txt file is a lot, it is not suitable for all LLMs, i.e. only Google Gemini 2.5 can handle it. In my opinion, we need to improve the documentation files for LLMs as follows (got the idea from the blog post):

  • llms-full.txt: include everything about Defold, i.e. manuals + API.
  • llms-small.txt: a compressed version of llms-full.txt, i.e. by removing docs about porting to consoles, IDE stylization etc, and keep docs only about programming.
  • llms/docs.md: manuals only, like llms-full.txt now.
  • llms/ref.md: API only.

It seems to me that this structure would be flexible enough to allow a developer to specify only documentation or APIs as the LLM context.

P.S. Actually, there is no clear instruction in the community right now about what type of content you need to ‘feed’ LLM to have high quality answers.

@aglitchman
Copy link
Contributor Author

llms-full.txt generator is located here - https://github.com/defold/defold.github.io/blob/master/update.py#L335

@aglitchman
Copy link
Contributor Author

llms-full.txt file is already accessable from the Internet - https://defold.com/llms-full.txt

@aglitchman
Copy link
Contributor Author

Plus, it would be great to write a manual page or a special page for LLMs only with Protobuf formats of all Defold files.

@yerumaku
Copy link

Plus, it would be great to write a manual page or a special page for LLMs only with Protobuf formats of all Defold files.

If the template files were commented, it would be possible to use them as a basis.

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

No branches or pull requests

2 participants