Ensure documentation uses consistent structural elements and proper metadata to optimize user experience and content discoverability. Use platform-native components (like `aside` instead of `callout` for Astro docs), include appropriate sidebar labels, and leverage weight/filter properties to control search result prominence.
Ensure documentation uses consistent structural elements and proper metadata to optimize user experience and content discoverability. Use platform-native components (like aside instead of callout for Astro docs), include appropriate sidebar labels, and leverage weight/filter properties to control search result prominence.
Key practices:
Example frontmatter:
---
title: 'affected:graph - CLI command'
sidebar:
label: Introduction
weight: .1
filter: "type:References"
---
This approach prevents deprecated or less relevant content from dominating search results while ensuring users can navigate documentation intuitively.
Enter the URL of a public GitHub repository