README.md

CodeGate docs

This repository contains the public-facing docs for CodeGate, hosted at https://docs.codegate.ai.

• Contributing to docs
• Local development
• Formatting
• Building the site
• Deployment
• About

Contributing to docs

We welcome contributions to the CodeGate documentation - if you find something missing, wrong, or unclear, please let us know via an issue or open a PR!

Please review the style guide for help with voice, tone, and formatting.

Local development

npm install
npm run start

This command starts a local development server on port 3000 and opens a browser window to http://localhost:3000. Most changes are reflected live without having to restart the server.

Formatting

We use a combination of Prettier, markdownlint, and ESLint to normalize formatting and syntax. Before you submit a PR, please check for issues:

npm run prettier
npm run markdownlint
npm run eslint

To automatically fix issues:

npm run prettier:fix
npm run markdownlint:fix
npm run eslint:fix

Building the site

npm run build

This command generates static content into the build directory. It also checks for broken links, so it's recommended to run this before submitting a PR.

Deployment

The docs.codegate.ai site is published using Vercel. Automatic previews for branches and pull requests are enabled. The production site is published from the main branch.

About

This site is built with Docusaurus, a modern static website generator.