Proposal: Update Documentation Structure for Improved Clarity and Usability

[jsparkdev]

Description

Purpose

The goal of this proposal is to update the documentation structure to make it more user-friendly and efficient.

Reasons for Update

The current documentation has the following issues:

• The sidebar's navigation structure, with levels like Blob - Methods - content, is too deep, resulting in a frustrating user experience.
• Methods available for a single class are scattered across multiple pages, fragmenting the information.
• Implementation details (e.g., signatures) are included, which users don’t necessarily need to know.

Proposed Changes

I’ve updated the structure as follows (see attached screenshots):

• Each sidebar menu item corresponds to a single class or function.
• Only essential information is provided for each method: type, a brief description, and example code, keeping it concise yet comprehensive.
• Method names are set as level-2 headings (##), enabling quick navigation via the right-side table of contents.

Screenshots:

• Current structure:
• Proposed structure:

Expected Benefits

• Users can select a specific class or function from the sidebar and view all information about it on a single page.
• By removing unnecessary details, the documentation becomes concise while retaining all critical information.

Feedback

I’d appreciate feedback from the community on this proposed change. Let me know if there’s anything to adjust or improve!

[hyunbinseo]

I agree with the following issues. A single file llms.txt would be useful as well.

• Methods available for a single class are scattered across multiple pages, fragmenting the information.
• Implementation details (e.g., signatures) are included, which users don’t necessarily need to know.