Skip to content

Enhance the information architecture of the Docling docs to provide a better user experience #2570

@bobbinrobyn

Description

@bobbinrobyn

Requested feature

Make a few improvements to the IA of the Docling docs to provide a better user experience by making it clearer where to start and what the key features of Docling are.

I recommend breaking this into 3 enhancements:

  1. Merge the homepage and the Getting Started page to get users into the meat of the docs content more quickly. Rename this page "Documentation."
  2. Reorganize "Concepts" and "Examples" and their sub-pages to live within the newly renamed Documentation section.
  3. Reorganize the newly renamed Documentation section, including creating some new pages in the that are named according to key Docling features, in order of how a user would typically encounter them:

Alternatives

I considered several other options for the sub-pages within the Usage section, but landed on this list via collaboration with @mingxzhao.

Approach

I plan to submit a PR for first recommended enhancement this week.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions