Documentation should be structured to optimize user navigation and information discovery. When organizing documentation elements: 1. Group related information into logical categories to help users find relevant content faster
Documentation should be structured to optimize user navigation and information discovery. When organizing documentation elements:
For example, when creating documentation indexes or navigation elements:
# Good organization example
documentation_links:
# Community resources (general info)
- name: Documentation
url: https://docs.example.org/
about: Official Documentation
- name: Community Support
url: https://community.example.org/
about: Get help from the community
# Component-specific resources (alphabetically sorted)
- name: API Reference
url: https://api.example.org/
about: Please refer to the API documentation
- name: Installation Guide
url: https://install.example.org/
about: Follow the installation steps
This organization style makes navigation intuitive and ensures users can quickly find the information they need, rather than getting lost in poorly structured documentation.
Enter the URL of a public GitHub repository