Docs refactor - key components

[Disiok]

Motivation

• retriever, query engine, chat engine are key concepts in llamaindex, but are currently hidden under query interface tab
• we don’t do a good job of showcasing all the modules that we have (e.g. vector index auto retriever)
• no consistent structure in sections
• We don’t do a good job of showing the intended usage pattern for each component (we have a big usage pattern section that lumps everything together)

Proposed Change

• bring retriever, query engine, chat engine to top level
• make each section have consistent sub-sections
  • concept
  • usage pattern
  • modules
  • (optional) advanced, etc
• better link between key components (e.g. connector <> index <> retriever <> query engine)
• Add doc make mapping between retriever mode and retriever class explicit.

Future Work

• data agent section

[jerryjliu]

high-level looks good! i like the organization of "concepts" and "modules"

one comment: i noticed all the guides are now under a "Modules" section - to me "Modules" on its own suggests that it's an API reference. could be worth having an API reference section for each section to reduce confusion

[jerryjliu]

think you can link to the specific sections with "index_guide.md#list-index" etc.

[Disiok]

Oh nice.

[Disiok]

Hmm tried it quickly and doesn't seem to work.

[jerryjliu]

you need to use relative links iirc

[logan-markewich]

Great changes so far. I like the idea of adding a more defined structure to the key sections, makes things easier to navigate