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.
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.
Description:
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.
Grouping Remote Functions by Resource: