Skip to content

Documentation quality check: fill reader-question gaps on 4 pages - #6775

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/5781eee7
Open

Documentation quality check: fill reader-question gaps on 4 pages#6775
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/5781eee7

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Reviewed English MDX files updated in the last day with a two-phase quality check and filled the gaps four pages left unanswered.

Changes

assistant/widget.mdx

  • Gap: The identity option is described as a "Signed end-user identity token" but the page never explains how to produce one or when it is verified.
  • Fix: Added an Authenticate end users section covering when identity tokens are verified (JWT auth configured), required claims (sub, aud, iat, exp), supported algorithms (EdDSA, ES256), and where to sign them.

deploy/reverse-proxy.mdx

  • Gap: The frontmatter description promised Nginx, Apache, and Caddy examples, but only Nginx configuration is provided.
  • Fix: Narrowed the description to Nginx and added a note in the intro that the routing/header requirements apply to any reverse proxy, with Nginx used for the example configs.

migration-services/go-live-checklist.mdx

  • Gap: Description mentioned SEO verification but the checklist had no SEO section; SSO/authentication, redirects, and custom domain were listed but had no verification steps.
  • Fix:
    • Added a Security verification section with explicit test-sign-in steps for SSO, SCIM, and end-user authentication.
    • Added an SEO section covering sitemap, search-console submission, noindex cleanup, and OG images.
    • Added redirect verification to the content-validation bullet.
    • Added DNS, TLS, and old-domain redirect verification bullets under Go live.

organize/related-pages.mdx

  • Gap: The page didn't explain why automatic suggestions might be empty beyond end-user authentication.
  • Fix: Added a When suggestions don't appear section listing indexing delay after deploy, insufficient similar content, end-user auth, and explicit related: false.

Context

No changes were made for pages where the identified gaps required inventing specifics (credit-cost ranges for automations, sandbox tool inventory, Vercel Host header value, custom-portal timelines) that could not be verified from the source repos.


Note

Low Risk
MDX documentation and localized copy only; no application code, APIs, or runtime behavior changes.

Overview
This PR closes documentation gaps on four pages and mirrors the same additions in es, fr, and zh.

On assistant/widget, it adds Authenticate end users guidance for signed identity tokens: when verification applies (JWT auth), required claims (sub, aud, iat, exp), EdDSA/ES256 signing, and server-side-only key handling.

deploy/reverse-proxy tightens the description to Nginx-focused examples and states that routing, methods, and headers apply to any proxy (Apache, Caddy, HAProxy).

migration-services/go-live-checklist expands pre-launch steps with Security verification (SSO, SCIM, site auth), a new SEO section, browser redirect checks, and Go live DNS/TLS/old-domain checks.

organize/related-pages adds When suggestions don't appear for empty automatic Related topics (index delay, sparse content, end-user auth, related: false).

Reviewed by Cursor Bugbot for commit f5e69e2. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify-development

mintlify-development Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
userauth 🟢 Ready View Preview Jul 28, 2026, 10:16 AM

@mintlify-development

mintlify-development Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
prosignuptest 🟢 Ready View Preview Jul 28, 2026, 10:25 AM

@mintlify-development

mintlify-development Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 28, 2026, 10:18 AM

@mintlify-development

mintlify-development Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
testing 🟢 Ready View Preview Jul 28, 2026, 10:30 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 28, 2026, 10:14 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟡 Building Jul 28, 2026, 10:12 AM

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟡 Building Jul 28, 2026, 10:12 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant