Clarify that hidden API endpoints are automatically noindexed#4575
Clarify that hidden API endpoints are automatically noindexed#4575devin-ai-integration[bot] wants to merge 2 commits intomainfrom
Conversation
Co-Authored-By: bot_apk <apk@cognition.ai>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
Requested by: jon |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ### Hiding endpoints | ||
|
|
||
| You can hide an endpoint from the API Reference by setting `hidden` to `true`. The endpoint will still be accessible at its URL. | ||
| You can hide an endpoint from the API Reference by setting `hidden` to `true`. The endpoint will still be accessible at its URL but is automatically excluded from search engine indexing (`noindex`), so you don't need to set `noindex` separately. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'separately' if it's not important to the meaning of the statement.
|
|
||
| ## Hidden API endpoints are automatically noindexed | ||
|
|
||
| API endpoints set to `hidden: true` in `docs.yml` are now documented as automatically excluded from search engine indexing. You don't need to separately configure `noindex` for hidden endpoints — hiding an endpoint removes it from both the sidebar and search results. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
|
|
||
| ## Hidden API endpoints are automatically noindexed | ||
|
|
||
| API endpoints set to `hidden: true` in `docs.yml` are now documented as automatically excluded from search engine indexing. You don't need to separately configure `noindex` for hidden endpoints — hiding an endpoint removes it from both the sidebar and search results. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'separately' if it's not important to the meaning of the statement.
|
|
||
| ## Hiding an API endpoint | ||
|
|
||
| You can hide individual API endpoints from the sidebar by setting `hidden: true` in the endpoint's layout configuration in `docs.yml`. Hidden endpoints are automatically excluded from search engine indexing — there's no need to separately set `noindex: true`. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'separately' if it's not important to the meaning of the statement.
|
🌿 Preview your docs: https://fern-preview-fern-clarify-hidden-noindex.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: bot_apk <apk@cognition.ai>
1 participant
Summary
Updates documentation to clarify that API endpoints set to
hidden: trueindocs.ymlare automatically excluded from search engine indexing — no separatenoindexconfiguration is needed. This was unclear from existing docs and surfaced as a customer question.Changes:
customize-api-ref.mdx: Updated the "Hiding endpoints" description to mention automaticnoindexbehavior.hiding-content.mdx: Added a new "Hiding an API endpoint" section (between "Hiding a page" and "Hiding a section or version") with a YAML example and a link to the full endpoint-hiding configuration.changelog/2026-03-26.mdx: Added changelog entry for this documentation improvement.Updates since last revision
Review & Testing Checklist for Human
hidden: trueon an endpoint automatically appliesnoindex— was confirmed in Slack by Jon but should be verified against actual product behavior before merging./learn/docs/api-references/customize-api-ref#hiding-endpointsand the changelog links to/learn/docs/customization/hiding-content#hiding-an-api-endpoint. Verify both anchors work in the preview.Notes
noindexworked on API ref pages. Jon confirmed hidden endpoints automatically get noindex.Link to Devin session: https://app.devin.ai/sessions/83e8f9119bef4f98970e93ad4edd669d