README.md

Codat docs

⚠️ These docs are in beta

They are in beta, so you may find some snags in our content.

You can contribute to them, or see the old ones here.

The official Codat documentation.

• Browse the docs
• Contributing Guide
• OpenAPI Spec
• Product roadmap | DX roadmap

---

Running locally

Create a .env file

The docusaurus config expects certain environment variables to be defined. We've included .env.example - copy this and rename it to .env. You can enter any random string for the IDs.

copy .env.example .env # on Windows 
cp .env.example .env # on Mac

Run the project

npm install
npm run start

Editing article markdown files

/docs

---

Updates feed: https://codat-docs.vercel.app/updates/rss.xml

---

Built with Docusaurus.