Skip to content

docs: point SEO and navigation pages at one source for each topic - #8595

Merged
ethanpalm merged 1 commit into
mainfrom
docs/seo-navigation-dedupe
Nov 19, 2026
Merged

ethanpalm merged 1 commit into
mainfrom
docs/seo-navigation-dedupe

Conversation

@ethanpalm

@ethanpalm ethanpalm commented Nov 18, 2026 •

Copy link
Copy Markdown
Collaborator

Third PR in the job-based IA pass (after #8593 and #8594).

What changed

  • optimize/seo: the "SEO best practices" accordion repeated guides/seo in less detail. It's now one line that links to the guide.
  • organize/settings-seo: added seo.trailingSlash. The full docs.json reference and the SEO page already documented it, but the SEO settings page didn't.
  • organize/navigation: links to guides/navigation for advice on organizing content.

Smaller than proposed

In the review I said SEO and navigation were each covered three times. After reading the pages side by side, most of that is the right layering:

  • the guides are best-practice pages that link out
  • optimize/seo and organize/navigation are how-to pages
  • the settings-* pages are reference

The bigger duplication is the docs.json reference itself. Every property is documented both on the topic pages (organize/settings-*) and on organize/settings-reference. They've already drifted: seo.trailingSlash was missing from one of them. Consolidating to one reference is worth doing, but it's a bigger decision, so it isn't in this PR.

Checks

  • mint broken-links: no broken links
  • Vale: no findings on changed lines

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes: cross-links, removed duplicate accordions, and one new settings reference field with no runtime or security impact.

Overview
This PR deduplicates SEO and navigation guidance by replacing inline best-practice content with links to the dedicated guides, and fills a reference gap for seo.trailingSlash.

On optimize/seo, the four-accordion "SEO best practices" section is replaced with a single pointer to How to improve documentation SEO, so the how-to page no longer repeats what the guide already covers in more detail.

On organize/navigation, the intro now states that the page is about building navigation elements and links readers to How to structure documentation navigation for organizational advice.

On organize/settings-seo, seo.trailingSlash is documented as a ResponseField (canonical tags, og:url, sitemap, internal links; default false), aligning the SEO settings reference with optimize/seo and other refs where the option was already described.

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

- Replace the SEO best practices accordion on the SEO page with a link
  to the SEO guide, which covers the same advice in more depth
- Add seo.trailingSlash to the SEO settings reference; the full
  docs.json reference already had it
- Link the navigation page to the navigation guide for IA advice

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
Mintlify Docs 🟢 Ready View Preview Nov 18, 2026, 10:56 PM

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

@ethanpalm
ethanpalm merged commit 935a57a into main Nov 19, 2026
5 checks passed
@ethanpalm
ethanpalm deleted the docs/seo-navigation-dedupe branch November 19, 2026 00:53
@mintlify mintlify Bot mentioned this pull request Nov 19, 2026
mintlify Bot added a commit that referenced this pull request Nov 19, 2026
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
staging — 6a1f154c Deployed Nov 18, 2026 by mintlify[bot]
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