Documentation quality check: fill gaps on recently changed pages - #6986
Open
mintlify[bot] wants to merge 2 commits into
Open
Documentation quality check: fill gaps on recently changed pages#6986mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Ran a Diataxis-based quality check on the 24 English MDX files updated in the past day and closed reader-facing gaps on four of them.
Changes
editor/settings.mdxcustomize/custom-scripts.mdxdata-current-pathattribute on<html>is the escape hatch — it's already documented for CSS but not JS.document.documentElement.dataset.currentPathfrom custom JavaScript. Verified againstDataCurrentPathUpdaterinmintlify/mintthat the attribute is kept in sync during client-side navigation.guides/knowledge-base.mdx/ai/slack-bot, which is deprecated (new installations are blocked). Elsewhere on the same page the guide correctly recommends the Slack agent at/agent/slack./agent/slackand rewrote the description to match the agent's actual DM /@mentionflow.editor/pages.mdxAlso worth reviewing (not fixed this run)
assistant/widget.mdx— theidentityconfig field is described as a "signed end-user identity token," but the page does not explain how to mint or sign it. The verification code inmintlify/serveraccepts bothEdDSAandES256; worth a follow-up subsection or link to a dedicated widget-auth doc.dashboard/roles.mdx— no in-page "Invite a member" procedure; readers are sent to the dashboard without steps.dashboard/sso.mdx— group-to-role mapping requires contacting support; no example mapping shown.help-center/configure-oauth-with-auth0.mdx— Prerequisites assume a Regular Web Application already exists in Auth0; no verification step after saving settings.deploy/authentication-setup.mdx— no consolidated "Logout" note for the JWT flow (OAuth tab covers it via Logout URL).create/personalization.mdx— a one-sentence contrast with authentication ("personalization identifies visitors without gating pages") would help the mutual-exclusivity note.Open gaps deliberately not filled
assistant/widget.mdxidentity-token generation: writing this correctly requires product decisions (which signing key source? where in the dashboard?) that I could not verify from the docs ormintlify/serveralone. Leaving it as a documented gap rather than inventing detail.api/analytics/assistant-thread.mdxauthentication note: peer analytics endpoints (assistant-conversations,feedback, etc.) also do not restate auth on each page — the pattern is to rely on the OpenAPI-generated block plus/api/introduction. Not this page's problem.changelog.mdxRSS URL: the changelog already renders an in-app RSS button (rss-feed-buttoninmintlify/mint), so surfacing the raw/changelog/rss.xmlURL in prose would be redundant.Note
Low Risk
Changes are prose and link updates in MDX documentation with no application code or security-sensitive behavior.
Overview
Documentation-only updates across English and es, fr, and zh locales, closing gaps found in a recent quality review.
Custom JavaScript (
customize/custom-scripts.mdx): Adds guidance for running global custom JS only on specific routes by branching ondocument.documentElement.dataset.currentPath, noting that Mintlify keepsdata-current-pathon<html>during client-side navigation (the same pattern already documented for CSS).Web editor: Fixes a typo in Main branch autocommits (
editor/settings.mdx, “your sire” → “your site”). Under Manage pages / delete (editor/pages.mdx), documents recovery by reverting the delete commit in the Git provider and reloading the editor.Knowledge base guide (
guides/knowledge-base.mdx): Replaces the deprecated Slack bot link with the Mintlify agent in Slack (/agent/slack) and describes DM and@mentionusage with source citations.Reviewed by Cursor Bugbot for commit 9a65256. Bugbot is set up for automated code reviews on this repo. Configure here.