Repository navigation
Apply SEO and metadata best practices - #106
mintlify[bot] wants to merge 1 commit into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8262b95c47
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| title: "Get credit balance" | ||
| openapi: "GET /credits" | ||
| description: "Read the organization's pentest credit balance." | ||
| description: "Get the pentest credits available to your organization, with totals purchased, used, refunded and granted, and whether the organization is unlimited." |
There was a problem hiding this comment.
Mintlify renders description under the page title, so this new subtitle is followed immediately by line 7 restating the same credits, totals, and unlimited-status facts. Several other modified endpoint pages introduce the same description/body duplication, making readers consume each summary twice and leaving two copies that can drift apart. Consolidate each description and opening-paragraph pair while retaining the expanded metadata. .agents/skills/writing-docs/SKILL.mdL26-L30
Useful? React with 👍 / 👎.
Summary
Expanded descriptions under 70 characters on in-scope pages (frontmatter changed 2026-10-26 to 2026-11-02).
Changes
Failed check for every page: description under 70 characters. The OpenAPI operations define no
description, so frontmatter applies.api-reference/credits/get-credit-balance.mdxapi-reference/findings/count-findings.mdxapi-reference/pentests/discard-pentest.mdxapi-reference/pentests/estimate-pentest.mdxapi-reference/pentests/start-pentest.mdxapi-reference/pentests/update-pentest.mdxapi-reference/repos/get-pr-review-settings.mdxapi-reference/repos/update-pr-review-settings.mdxapi-reference/scans/stop-scan.mdxchangelog.mdxContext
code-review/spillover-usage→code-review/overage-usagealready has a redirect, so I made no redirect changes.