Skip to content

codacy/docs-curator

 
 

Repository files navigation

Pat Pat Bot

Codacy pattern doc generator.

Since this is a GH action, all code must be self-contained and ready to be executed in one file.

All compiled files in dist are therefore committed.

Using the GitHub action

Installing and running locally

  1. Set environment variables: cp .env.example .env and edit the file
  2. Install dependencies: npm i
  3. Install compiler: npm i -g @vercel/ncc
  4. Build: npm run build
  5. Run locally: npm run start

Usage

  • Add prompt files to the prompts folder.

    Prompts must be named <order>-<name>.json, where order is a number and name is a unique identifier.

About

AI Documentation Bot Curator

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 87.6%
  • Python 12.4%