Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UNIT] llama-index framework - release 3/3/25 #22

Open
wants to merge 47 commits into
base: main
Choose a base branch
from

Conversation

davidberenstein1957
Copy link
Member

No description provided.

@burtenshaw
Copy link
Collaborator

Looks nice. I don't see anything on:

  • integrations with databases and APIs
  • sentence transformers

@davidberenstein1957
Copy link
Member Author

Looks nice. I don't see anything on:

  • integrations with databases and APIs
  • sentence transformers

Yes, I've updated the ToC outside of here in a Google Docs, will update based on the feedback of llama-indextomorrow.

@burtenshaw burtenshaw changed the title Add general outline llama-index based on TOC [UNIT] llama-index framework - release 3/3/25 Feb 10, 2025
@burtenshaw burtenshaw marked this pull request as draft February 10, 2025 12:34
@burtenshaw burtenshaw self-requested a review February 10, 2025 12:35
@burtenshaw
Copy link
Collaborator

@davidberenstein1957 We'll release this unit in 3 weeks.

@HuggingFaceDocBuilderDev
Copy link
Collaborator

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@davidberenstein1957 davidberenstein1957 marked this pull request as ready for review February 10, 2025 17:27
@davidberenstein1957 davidberenstein1957 marked this pull request as draft February 10, 2025 17:27
@davidberenstein1957 davidberenstein1957 marked this pull request as ready for review February 12, 2025 20:07
@burtenshaw
Copy link
Collaborator

[ REVIEW PLAN ] @davidberenstein1957

I'd propose this:

  • respond to my comments
  • take it to LlamaIndex folk
  • final review copy

@burtenshaw burtenshaw self-assigned this Feb 18, 2025
@davidberenstein1957
Copy link
Member Author

- Create new  file explaining LlamaHub integration and usage
- Update  with refined section titles for LlamaIndex unit2
- Refine documentation for agents, components, and tools sections
- Add quiz data for unit 2
- Improve narrative flow and explanations across documentation files
- Create new `llama-hub.mdx` file explaining LlamaHub integration and usage
- Update `_toctree.yml` with refined section titles for LlamaIndex unit2
- Refine documentation for agents, components, and tools sections
- Add quiz data for unit 2
- Improve narrative flow and explanations across documentation files
- Add LlamaHub section to the unit2 table of contents
- Expand navigation for LlamaIndex documentation
- Add tools illustration image to LlamaIndex tools section
- Remove extra newline in unit0 introduction
- Change code block language from 'python' to 'bash' for pip install command
- Add spacing and formatting improvements to installation details
- Clarify steps for obtaining LlamaTrace API key
- Refactor text to emphasize QueryEngine's role in RAG workflows
- Add explanation of RAG and its importance for LLMs
- Update image reference and improve narrative clarity
- Remove redundant content and streamline explanation
- Add illustrative images to agents and components pages
- Convert external links to HTML anchor tags
- Enhance text formatting and readability
- Add additional context and links to documentation resources
…tting

- Update introduction to reorder framework descriptions
- Enhance agent documentation with bolded key concepts
- Highlight important points in components documentation
- Improve readability and visual clarity of explanations
… and visual elements

- Add workflow schematic image to illustrate workflow concept
- Refactor text to improve clarity and readability
- Highlight key workflow benefits and concepts
- Add code examples for workflow creation, multi-step workflows, and state management
- Improve formatting with bolded text and tip component
- Create two new quiz MDX files for LlamaIndex unit2
- Update _toctree.yml to include quiz sections in navigation
- Add ungraded self-check quizzes to reinforce learning about LlamaIndex components, tools, and agents
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants