Skip to content

docs(nav): fix docs.json navigation, redirects, and OpenAPI wiring gaps - #195

Merged
soamdesai-tfh merged 4 commits into
mainfrom
docs-audit/docs-json-nav-fixes
Sep 24, 2026
Merged

docs(nav): fix docs.json navigation, redirects, and OpenAPI wiring gaps#195
soamdesai-tfh merged 4 commits into
mainfrom
docs-audit/docs-json-nav-fixes

Conversation

@soamdesai-tfh

@soamdesai-tfh soamdesai-tfh commented Sep 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fix docs.json navigation and redirects.

  • Add 4 missing Developer Portal API pages and the missing World ID recovery-agent endpoints to the nav.
  • Repoint 12 dead redirects and 3 stale #legacy-presets redirects to real pages/anchors.
  • Link the orphaned integration-prompt.mdx from build-with-llms.mdx.
  • Delete the stale, unreferenced openapi/world-id.json.

Not changed: credit-api and world-chat-qa stay out of the nav. Both were de-listed on purpose (#27 and #5), so re-listing them needs owner sign-off.

Skipped: one finding filed against the wrong file — it was a duplicate of the recovery-agent fix above.

@soamdesai-tfh
docs(nav): fix docs.json navigation, redirects, and OpenAPI wiring gaps
79eb1ee 
- docs.json: add 4 missing Developer Portal OpenAPI operations
  (create-incognito-action, get-action-metadata, get-jwk-keys,
  graphql-proxy) to the "Developer Portal" nav group's pages array
- docs.json: add the missing recovery-agent endpoints to the World ID
  Indexer (/pending-recovery-agent, /recovery-agent) and Gateway
  (/health, /initiate-recovery-agent-update,
  /execute-recovery-agent-update, /cancel-recovery-agent-update) API
  reference groups so they match the live OpenAPI specs already
  linked in docs.json
- docs.json: repoint 12 redirect rules that 308'd to destinations
  which themselves 404 on production (e.g. /idkit, /js, /zkp,
  /further-reading/*, /reference/errors, /try,
  /world-id/quick-start/templates, /world-id/id/web-react) to pages
  that actually exist
- docs.json: repoint 3 legacy "#legacy-presets" redirects to the
  correct two-hop-free destination
  /world-id/idkit/credentials#other-legacy-presets
- docs.json: add mini-apps/sharing/world-chat-qa to the Quick Actions
  nav group and mini-apps/reference/credit-api to the Mini Apps
  Technical Reference group so these already-written, live pages are
  reachable from the sidebar
- world-id/idkit/build-with-llms.mdx: link to the previously orphaned
  world-id/idkit/integration-prompt.mdx as a supplementary resource
- openapi/world-id.json: delete stale, unreferenced legacy spec
  superseded by openapi/developer-portal.json
@mintlify

mintlify Bot commented Sep 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
world 🟢 Ready View Preview Sep 23, 2026, 10:06 PM

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

@soamdesai-tfh

soamdesai-tfh commented Sep 21, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 21, 2026 •
edited
Loading

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-21T04:10:43.988589Z ea21ea9 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to 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" or "@codex security review".

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

chatgpt-codex-connector Bot commented Sep 21, 2026

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🚀

Reviewed commit: ea21ea9384

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@soamdesai-tfh
polish: tighten wording, match house style
7a0b554 
Shorten the standalone integration prompt callout in
build-with-llms.mdx to match the terse, single-sentence style used
elsewhere in the file.
@soamdesai-tfh

soamdesai-tfh commented Sep 21, 2026

Copy link
Copy Markdown
Contributor Author

Style pass on this PR's changes: tightened the standalone-integration-prompt callout in world-id/idkit/build-with-llms.mdx to a single terse sentence, matching the surrounding doc's voice. No content or JSON nav/redirect changes — docs.json and the OpenAPI diff needed no wording cleanup.

@soamdesai-tfh
soamdesai-tfh force-pushed the docs-audit/docs-json-nav-fixes branch from 03a4140 to 7a0b554 Compare September 21, 2026 17:26
@soamdesai-tfh
docs(nav): keep credit-api and world-chat-qa out of the nav
1a2f6ef 
- Both pages were de-listed on purpose: credit-api in #27 ("remove credit
  scoring nav") and world-chat-qa in #5. Re-listing them needs owner
  sign-off, so this PR no longer adds them back.
@soamdesai-tfh
soamdesai-tfh merged commit 10536b5 into main Sep 24, 2026
9 checks passed
@soamdesai-tfh
soamdesai-tfh deleted the docs-audit/docs-json-nav-fixes branch September 24, 2026 00:17

This branch was successfully deployed

1 active deployment
staging — 1a2f6ef6 Deployed Sep 23, 2026 by mintlify[bot]
View deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kchaw2005 kchaw2005 kchaw2005 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@soamdesai-tfh @kchaw2005