-
Notifications
You must be signed in to change notification settings - Fork 370
Description
Overview
The base/docs site contains a mix of conceptual guides, tutorials, and detailed reference documentation, but the connections between these sections are not always clear. Adding stronger navigation and cross-links would make it easier for readers to understand how concepts map to concrete APIs and tools.
Readers often enter the documentation from search results or external links and land directly on a reference page without any surrounding context. Others may read a conceptual guide and struggle to find the exact API or configuration details needed to apply what they’ve learned. This disconnect can make the docs feel fragmented and forces users to manually search for related information.
Proposed Solution
Add clearer navigation and contextual links between conceptual guides and their related reference documentation. This could include sections like “Related Concepts,” “Relevant APIs,” or “Next Steps” at the end of pages, as well as inline links where appropriate. The goal is to help readers understand how different parts of the documentation relate to each other and to support a smoother learning path from introduction to implementation.