-
Notifications
You must be signed in to change notification settings - Fork 0
chore: post-go-live hardening (CODEOWNERS, release checklist) #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # ASG Agent Cloud - Public Documentation | ||
|
|
||
| > **Live Site:** <https://docs.asgcompute.com> | ||
|
|
||
| ## 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 | ||
|
Comment on lines
+66
to
+67
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Capitalize “GitHub” consistently. 🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
Comment on lines
+16
to
+18
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Align OpenAPI path with repo structure. 🤖 Prompt for AI Agents |
||
|
|
||
| ### 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 | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: ASGCompute/asg-docs-public
Length of output: 1385
Remove or create the
/auth/*CODEOWNERS rule to match actual directory structure.The paths in CODEOWNERS are already correctly positioned at the repository root—
/openapi/,/security/,/billing/, and/api/all exist and don't need adocs/prefix. However, the rule/auth/*@ASGCompute/security@ASGCompute/cto`` references a non-existent directory. Either remove this rule or create the missing/auth/directory.🤖 Prompt for AI Agents