Skip to content

feat: Add llms.txt and llms-full.txt in the docs #5

@emerson-proenca

Description

@emerson-proenca

Context

This is 2026 and more and more people are vibecoding, it just makes sense to add a llms.txt from day 1. It makes the language more approchable by complete begginers or people who just want to try things out.

Proposal

Implement two files in the root directory/docs to serve as the "Source of Truth" for AI models:

  • llms.txt: A brief, high-level summary of Vix syntax, type system, links and project structure.
  • llms-full.txt: A comprehensive markdown file containing the full API surface, including the libraries and all internal modules.

Reference

Many Companies, Frameworks and Libraries do this:

Benefits

  • Reduces Hallucination: Stops LLMs from mixing Python-style colons with Vix end keywords.
  • Vibe coding: Tools like Cursor, Windsurf, and Copilot can instantly ingest the language rules.
  • Faster Adoption: Developers can create libraries faster if the AI knows the language rules.

Implementation

Since the language is still evolving, we should automate this. I'm not exactly sure the best way to go about this, we can take a look at others libraries and understand how they did it and copy from them. Or just find a way to do it ourselves, if the community approves the idea I'd like to help implement this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions