From c16252bb7ca5d91583a1b0cf3bb9eb53d52f3569 Mon Sep 17 00:00:00 2001 From: pTinosq Date: Wed, 13 Aug 2025 11:19:02 +0100 Subject: [PATCH 1/2] Create LLMS.TXT file --- llms.txt | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 llms.txt diff --git a/llms.txt b/llms.txt new file mode 100644 index 0000000..f31a6b1 --- /dev/null +++ b/llms.txt @@ -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 \ No newline at end of file From 22c700408ee575c0c520140b16dac13916956428 Mon Sep 17 00:00:00 2001 From: pTinosq Date: Wed, 13 Aug 2025 11:20:01 +0100 Subject: [PATCH 2/2] Moved to correct folder --- llms.txt => static/llms.txt | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename llms.txt => static/llms.txt (100%) diff --git a/llms.txt b/static/llms.txt similarity index 100% rename from llms.txt rename to static/llms.txt