Publishing Workflow

​

Production source

​

Staging source

​

Review flow

1. Open a pull request against staging.
2. Update MDX pages and any schema snapshot changes together.
3. Run local docs checks.
4. Review the Mintlify preview deployment.
5. Merge to staging after approval to update staging docs.
6. Promote the docs changes to main through the repository release flow to update docs.brightplace.ai.

​

Required checks

python developer-docs/scripts/check_public_tool_schemas.py
cd developer-docs
npx mint validate --disable-openapi
npx mint broken-links --check-anchors
npx mint a11y

​

Domain setup

1. Add docs.brightplace.ai in the Mintlify project that watches main.
2. Add the two verification TXT records shown in the dashboard.
3. After both TXT records verify, add the production CNAME record:

CNAME docs cname.mintlify.builders

4. Add staging-docs.brightplace.ai in the Mintlify project that watches staging.
5. Add the staging verification TXT records shown in that dashboard.
6. After both staging TXT records verify, add the staging CNAME record:

CNAME staging-docs cname.mintlify.builders

7. Wait for DNS propagation and TLS provisioning.
8. Verify:

curl -I https://docs.brightplace.ai
curl -I https://staging-docs.brightplace.ai

​

Launch checklist

• https://docs.brightplace.ai resolves with TLS.
• https://staging-docs.brightplace.ai resolves with TLS.
• The production Mintlify project deploys from main.
• The staging Mintlify project deploys from staging.
• The homepage renders Advisor Connect launch content.
• Claude and ChatGPT install pages are live.
• Tool reference includes only the four launch tools.
• Privacy, Terms, Fair Housing, support, and security links are present.
• BP-317 launch materials link to docs instead of duplicating setup content.