Repository navigation
docs: point SEO and navigation pages at one source for each topic - #8595
Merged
Merged
Conversation
- 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>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Merged
This branch was successfully deployed
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
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.
Third PR in the job-based IA pass (after #8593 and #8594).
What changed
optimize/seo: the "SEO best practices" accordion repeatedguides/seoin less detail. It's now one line that links to the guide.organize/settings-seo: addedseo.trailingSlash. The fulldocs.jsonreference and the SEO page already documented it, but the SEO settings page didn't.organize/navigation: links toguides/navigationfor 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:
optimize/seoandorganize/navigationare how-to pagessettings-*pages are referenceThe bigger duplication is the
docs.jsonreference itself. Every property is documented both on the topic pages (organize/settings-*) and onorganize/settings-reference. They've already drifted:seo.trailingSlashwas 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🤖 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.trailingSlashis documented as aResponseField(canonical tags,og:url, sitemap, internal links; defaultfalse), aligning the SEO settings reference withoptimize/seoand 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.