Skip to content

Improve hiding content docs to better distinguish hidden vs noindex#4793

Merged
devalog merged 3 commits intomainfrom
devin/1775519214-improve-hiding-content-docs
Apr 7, 2026
Merged

Improve hiding content docs to better distinguish hidden vs noindex#4793
devalog merged 3 commits intomainfrom
devin/1775519214-improve-hiding-content-docs

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Summary

Restructures the Hiding content page to better distinguish hidden: true from noindex: true, based on user feedback that the current page was misleading.

Key changes:

  • Intro: Replaced single-paragraph description with a bullet list clearly defining each setting's behavior
  • Hiding a page: Clarified that page-level hidden: true automatically excludes from search — no need to also set noindex in frontmatter
  • New section "Excluding a page from search only": Promoted the noindex-only use case from a buried <Info> callout to its own section with a standalone code example
  • Hiding a section or version: Added explicit contrast with page-level behavior ("Unlike page-level hidden...")
  • Cross-references updated: SEO metadata page and hidden page example updated to match new messaging

Review & Testing Checklist for Human

  • Verify that page-level hidden: true does in fact auto-set noindex. This is the central claim of the rewrite and came from internal Slack — if the product behavior differs, the docs would be wrong.
  • The hidden page example (hiding-content-example.mdx) still has noindex: true in its frontmatter (line 3). Consider whether to remove it since the docs now say it's redundant, or leave it as-is.
  • Preview the rendered page to confirm the new structure (intro bullets, two distinct sections for hidden vs noindex) reads well and the code examples are clear.

Notes

  • The metadata.mdx file had pre-existing Vale errors unrelated to this PR (pixel units, Twitter heading casing); those were left as-is.
  • The llms-txt.mdx cross-reference was already accurate and didn't need changes.

Link to Devin session: https://app.devin.ai/sessions/edf7c4c922c44979bacea6e1fcadd67a

- Clarify that page-level hidden: true automatically excludes from search (no need for separate noindex)
- Promote noindex-only use case to its own section instead of burying in a callout
- Better distinguish behavior differences between page-level and section-level hidden
- Update cross-references in SEO metadata page and hidden page example

Co-Authored-By: bot_apk <apk@cognition.ai>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@fern-api
Copy link
Copy Markdown
Contributor

fern-api bot commented Apr 6, 2026

Requested by: jon
Slack thread: View conversation

@devin-ai-integration devin-ai-integration bot requested a review from devalog as a code owner April 6, 2026 23:49
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 6, 2026

@devalog devalog merged commit 624816a into main Apr 7, 2026
2 checks passed
@devalog devalog deleted the devin/1775519214-improve-hiding-content-docs branch April 7, 2026 13:52
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