From 357f8020334a316ce403b57168ab8e9fcd9eec29 Mon Sep 17 00:00:00 2001 From: pTinosq Date: Mon, 11 Aug 2025 15:06:22 +0100 Subject: [PATCH] Improve the README --- README.md | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 15bce5f..e913991 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ -# Recurse Docs +# Recurse ML Docs 🤓 -⚠️ WORK IN PROGRESS ⚠️ +This repository contains the public documentation for Recurse ML. Recurse ML is an AI-powered static analysis tool that catches bugs your tests miss. Here you will find guides, examples and references for using Recurse to detect breaking changes, prevent API misuse and enforce your own coding rules from GitHub or your CLI. -## Installation +The website is hosted at: [docs.recurse.ml](https://docs.recurse.ml) + +## Developing locally + +Our documentation uses [docusaurus](https://docusaurus.io) so to get started, clone the repository and run: ```bash npm install ``` -## Local Development +Then to run the docs locally, run the following command: ```bash npm start @@ -16,26 +20,21 @@ npm start This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. -## Build +## Building the project + +Before submitting a PR, please verify that the project builds without any errors. This can be achieved by running: ```bash -npm build +npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. -## Deployment - -Using SSH: - -```bash -USE_SSH=true npm deploy -``` - -Not using SSH: +## Reporting Issues +If you find an error or outdated information in the docs, please create an issue in this repository. -```bash -GIT_USER= npm deploy -``` +## Contributing +We welcome contributions of all sizes. Please open an issue to discuss major changes before submitting a pull request. -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +## License +This documentation is licensed under the MIT License. See LICENSE for details. \ No newline at end of file