-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Open
Labels
enhancementNew feature or requestNew feature or request
Description
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:
- Merge the homepage and the Getting Started page to get users into the meat of the docs content more quickly. Rename this page "Documentation."
- Reorganize "Concepts" and "Examples" and their sub-pages to live within the newly renamed Documentation section.
- 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:
- Getting started
- Install
- Quickstart
- Usage
- Ingest
- Convert
- Extract
- Chunk
- Embed and Index
- Export and Serialize
- Integrate
- Self-Hosting
- Advanced usage
- Advanced options
- Supported formats
- Enrichment features
- Vision models
- GPU support
- MCP server
- Jobkit
- FAQ
4. (Bonus) Add collapse/expand functionality within the lefthand side navigation of the docs.Will create a separate issue for this
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
Labels
enhancementNew feature or requestNew feature or request