Improvements to central.ballerina.io API Documentation

[niveathika]

Description:

1. Improvements to Left-Side Navigation:

   • Current State: The left-side navigation in the central file currently excludes Module.md file headings, which can make it challenging to navigate through lengthy descriptions, including setup guides, quickstarts, and examples.

   • Suggested Improvement: Enhance the left-side navigation by including all pertinent headings from the Module.md file, up to a defined level (e.g., level 2). This improvement aims to provide users with a more organized and user-friendly experience, facilitating better navigation without overwhelming them with extensive setup guidelines.

     

2. Grouping Remote Functions by Resource:

   • Current State: Documentation for connectors with a large number of APIs can become unwieldy when presented as a single list.
   • Suggested Improvement: Explore a grouping mechanism, inspired by the Google API docs format, to organize remote functions based on the associated resource. This can significantly improve navigation and user-friendliness.

[niveathika]

1. Left Navigation Pane

   • Proposing the display of Module.md file headings on the left side navigation under a dedicated "Overview" section.
   • The display should also include configurables in the module.

2. Reorganizing Resource Function Grouping in Navigation:

   • Discussing the reorganization of resource function grouping in navigation.
   • Proposal to derive grouping from path segments (excluding path parameters).
   • Consideration of grouping using ballerina annotations.
   • Alternative suggestion: View resources as a hierarchy rather than grouping.

@sm1990 will develop base UI templates for the suggested approaches