Skip to content

Create LLMS.TXT file #12

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.

Sign up for GitHub

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Create LLMS.TXT file #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c16252b
Create LLMS.TXT file
pTinosq Aug 13, 2025
22c7004
Moved to correct folder
pTinosq Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions static/llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Recurse ML Documentation

> Recurse ML is an AI-powered static analysis tool that catches bugs your tests miss. This documentation site provides comprehensive guides, examples, and references for using Recurse ML to detect breaking changes, prevent API misuse, and enforce custom coding rules through GitHub integration or CLI usage.

Recurse ML offers two main ways to integrate static analysis into your development workflow: as a GitHub App for automated pull request reviews, or as a command-line tool for local development and CI/CD pipelines. The tool is designed to catch issues that traditional testing methods often miss, helping developers maintain code quality and prevent bugs from reaching production.

## Getting Started

- [RML CLI Quickstart](https://docs.recurse.ml/rml/): Get up and running with RML CLI in just a few steps, including installation guides for Linux and macOS
- [GitHub App Quickstart](https://docs.recurse.ml/gh/): Install and configure the Recurse ML GitHub App to automatically review pull requests

## Core Features

- [RML CLI Reference](https://docs.recurse.ml/rml/cli-reference/): Complete command-line interface documentation and usage examples
- [GitHub App Configuration](https://docs.recurse.ml/gh/configs/config-file-overview/): Set up and customize the Recurse ML GitHub App for your repositories
- [Rules Configuration](https://docs.recurse.ml/rml/configs/rules/): Create custom rules to enforce project-specific coding standards and conventions
- [Report Status Checks](https://docs.recurse.ml/gh/configs/report-status-checks/): Understand and configure how Recurse ML reports analysis results

## Configuration

- [Config File Overview](https://docs.recurse.ml/rml/configs/config-file-overview/): Learn about RML configuration files and their structure
- [GitHub App Rules](https://docs.recurse.ml/gh/configs/rules/): Configure rules specifically for GitHub App usage

## Help and Support

- [RML Help and Support](https://docs.recurse.ml/rml/help-and-support/): Troubleshooting guides and support resources for RML CLI
- [GitHub App Help](https://docs.recurse.ml/gh/help-and-support/): Support documentation for the Recurse ML GitHub App