Skip to content
Docs menu

RepoReady documentation

How the analysis works, what each check looks for, and how to connect coding agents and submission systems.

Last updated

Getting started

  1. 01

    Create an account

    Sign up with your email. New accounts get 3 free analyses.

  2. 02

    Create a project

    Choose one of your GitHub repositories, a public GitHub link or a zip upload.

  3. 03

    Add your manuscript

    Optional: upload a PDF, Word, Markdown, text or LaTeX zip, or link Overleaf.

  4. 04

    Start the analysis

    Your report shows the score and findings with suggested fixes.

  • GitHubTo choose from your own repositories, connect GitHub under Integrations. The RepoReady GitHub App reads only the repositories you choose and writes only when you ask for a pull request.
  • OverleafConnect Overleaf under Integrations with an Overleaf Git token and your project link. Overleaf Git is a paid Overleaf feature.

Also useful