https://github.com/stacklok/codegate-docs
CodeGate user documentation
https://github.com/stacklok/codegate-docs
Last synced: 7 months ago
JSON representation
CodeGate user documentation
- Host: GitHub
- URL: https://github.com/stacklok/codegate-docs
- Owner: stacklok
- License: apache-2.0
- Created: 2024-11-14T07:54:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-16T21:49:32.000Z (8 months ago)
- Last Synced: 2025-06-16T22:35:01.749Z (8 months ago)
- Language: TypeScript
- Homepage: https://docs.codegate.ai
- Size: 7.37 MB
- Stars: 2
- Watchers: 13
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚠️ DEPRECATED ⚠️
The [CodeGate](https://github.com/stacklok/codegate) project is deprecated and
archived. The information in this repository is no longer maintained or updated,
and the `docs.codegate.ai` site is no longer available.
# CodeGate docs
[](https://github.com/stacklok/codegate-docs/deployments/Production)
This repository contains the public-facing docs for CodeGate, hosted at
[https://docs.codegate.ai](https://docs.codegate.ai).
- [Contributing to docs](#contributing-to-docs)
- [Local development](#local-development)
- [Formatting](#formatting)
- [Building the site](#building-the-site)
- [Deployment](#deployment)
- [About](#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](./STYLE-GUIDE.md) for help with voice, tone, and
formatting.
## Local development
You'll need Node.js available (v22 recommended) or VS Code with the
[Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
extension and Docker.
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/stacklok/codegate-docs)
```bash
npm install
npm run start
```
This command starts a local development server on port 3000 and opens a browser
window to . 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:
```bash
npm run prettier
npm run markdownlint
npm run eslint
```
To automatically fix issues:
```bash
npm run prettier:fix
npm run markdownlint:fix
npm run eslint:fix
```
## Building the site
```bash
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](https://docusaurus.io/), a modern static
website generator.