Restructure documentation navigation #1526
Conversation
tzolov
commented
Oct 11, 2024
tzolov
commented
- Only the catalog is updated. No existing links are changed
- Move 'AI Concepts' under 'Overview'
- Reorganize API sections for better hierarchy
- Move 'Vector Databases' into its own top-level section
- Reposition 'Function Calling', 'Multimodality', 'Testing', and 'Structured Output' as top-level items
- Remove redundant nesting in some sections
- Comment out 'Generic Model' section
- Only the catalog is updated. No existing links are changed - Move 'AI Concepts' under 'Overview' - Reorganize API sections for better hierarchy - Move 'Vector Databases' into its own top-level section - Reposition 'Function Calling', 'Multimodality', 'Testing', and 'Structured Output' as top-level items - Remove redundant nesting in some sections - Comment out 'Generic Model' section
| ** xref:api/advisors.adoc[Advisors] | ||
| * xref:api/index.adoc[AI Models] | ||
| ** xref:api/chatmodel.adoc[Chat Models] | ||
| *** xref:api/prompt.adoc[] |
There was a problem hiding this comment.
I think the prompt stuff should move elsewhere. All the "API" subsections are specific to a model vendor whereas this is a higher level spring ai api topic.
| ** xref:api/etl-pipeline.adoc[] | ||
| ** xref:api/testing.adoc[] | ||
| ** xref:api/generic-model.adoc[] | ||
| ** xref:api/vectordbs/azure.adoc[] |
There was a problem hiding this comment.
Similar to the other comment, the ETL pipeline, while certainly being vector store focused, is it's own top level concern or concept and like the other AI Model sections, this is where I go to find specific info on a vendor's vector store as compared to the higher level topic of ETL.
|
|
||
| * xref:observabilty/index.adoc[] | ||
| * xref:api/functions.adoc[Function Calling] | ||
| * xref:api/multimodality.adoc[Multimodality] | ||
| * xref:api/testing.adoc[LLM Evaluation] |
There was a problem hiding this comment.
We rarely use LLM, i'll change to AI Model Evaluation
|
I moved a few sections around, can discuss and continue to refine. |
|
made some small updates to the feature listing in index.adoc merged in d523ffb |
