From e0c361eb3b0988d9fc0dbed97c25b269d6f3e628 Mon Sep 17 00:00:00 2001 From: Aidar Date: Sun, 1 Feb 2026 04:11:46 -0700 Subject: [PATCH] chore: add CODEOWNERS, release checklist, and README --- .github/CODEOWNERS | 26 +++++++++++++++++ README.md | 67 +++++++++++++++++++++++++++++++++++++++++++ RELEASE_CHECKLIST.md | 68 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 161 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 README.md create mode 100644 RELEASE_CHECKLIST.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..1ac1148 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,26 @@ +# Public Documentation Ownership +# Changes to these paths require review from designated owners + +# OpenAPI specification - security-sensitive +/openapi/* @ASGCompute/security @ASGCompute/cto + +# Security documentation +/security/* @ASGCompute/security + +# Billing and payments documentation +/billing/* @ASGCompute/cto @ASGCompute/billing + +# Authentication documentation +/auth/* @ASGCompute/security @ASGCompute/cto + +# API reference pages +/api/* @ASGCompute/cto + +# CI/CD workflows +/.github/ @ASGCompute/cto @ASGCompute/security + +# Mintlify configuration +mint.json @ASGCompute/cto + +# Leak banlist - critical for white-label compliance +.leak-banlist.txt @ASGCompute/security @ASGCompute/cto diff --git a/README.md b/README.md new file mode 100644 index 0000000..659c707 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +# ASG Agent Cloud - Public Documentation + +> **Live Site:** + +## Quick Start + +```bash +# Install dependencies +npm install + +# Start local dev server +npm run dev + +# Run all CI checks locally +npm run lint && npm run check:links && npm run check:leaks +``` + +## Making Changes + +1. Create a branch from `main` +2. Make your changes +3. Run local checks: `npm run lint && npm run check:links && npm run check:leaks` +4. Open a PR +5. Wait for CI to pass + required reviews +6. Merge to `main` → auto-deploys to Mintlify + +## Required Reviews + +See [CODEOWNERS](.github/CODEOWNERS) for path-specific requirements. + +**Always required for:** + +- OpenAPI spec changes +- Security documentation +- Billing documentation +- CI/CD workflow changes + +## Release Checklist + +Before merging, complete the [Release Checklist](RELEASE_CHECKLIST.md). + +## Structure + +``` +docs/ +├── mint.json # Mintlify configuration +├── openapi/ # OpenAPI specifications +│ └── public.openapi.yaml +├── quickstart/ # Getting started guides +├── concepts/ # Core concepts +├── auth/ # Authentication docs +├── billing/ # Payments & receipts +├── api/ # API reference +├── errors/ # Error handling +├── security/ # Security best practices +└── .github/ + ├── CODEOWNERS + └── workflows/ + ├── docs-ci.yml + ├── white-label-scan.yml + └── secret-scan.yml +``` + +## Support + +- **Internal:** #docs-eng Slack channel +- **Issues:** Open a GitHub issue in this repo diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md new file mode 100644 index 0000000..7b1ed61 --- /dev/null +++ b/RELEASE_CHECKLIST.md @@ -0,0 +1,68 @@ +# Docs Release Checklist + +Use this checklist before merging any documentation changes to `main`. + +## Pre-Merge Checklist + +### Content Quality + +- [ ] Spelling and grammar checked +- [ ] Code examples tested and working +- [ ] Links validated (internal and external) +- [ ] Screenshots up-to-date (if applicable) + +### API Changes + +- [ ] OpenAPI spec (`openapi/public.openapi.yaml`) updated if API changed +- [ ] Error codes documented in `/errors` section +- [ ] Breaking changes clearly marked with warnings + +### Security & Compliance + +- [ ] White-label scan passed (no vendor leaks) +- [ ] Secret scan passed (no keys, tokens, internal URLs) +- [ ] No internal architecture details exposed +- [ ] No internal URLs or IP addresses + +### Navigation & Discovery + +- [ ] New pages added to `mint.json` navigation +- [ ] Page has appropriate frontmatter (title, description) +- [ ] Canonical URLs correct + +### Changelog + +- [ ] `CHANGELOG.md` updated for user-facing changes +- [ ] Version bump if significant changes + +## Post-Merge Verification + +- [ ] Mintlify build succeeded +- [ ] Pages render correctly on production +- [ ] No 404s on new/moved pages +- [ ] Search index includes new content (~5 min delay) + +--- + +## Quick Commands + +```bash +# Run all checks locally +npm run lint && npm run check:links && npm run check:leaks + +# Preview locally +npm run dev + +# Validate OpenAPI +npm run lint:openapi +``` + +--- + +## Escalation + +If a security issue is found in production docs: + +1. **Immediately** remove sensitive content via direct push (bypass PR) +2. Notify security team in #security-incidents +3. Create post-mortem issue