Restructure navigation and update documentation #1703
Conversation
…Simplify sections and add new files for better organization and clarity. Adjust community resources and remove unnecessary redirects.
|
Thanks a ton Amir! Are we linking to some files that don't exist, i.e. is this a "draft"? For example, we link to debugging.md |
ammirsm
changed the title
Yes, sir. I'm adding some placeholders, and if you think that's sufficient and the structure is good, we'll fill them up. We'll then restructure the actual files to make them tidy and push the first version of this structure up. I wanted to keep the first version of the PR simple to make it easier to review. |
Organize the navigation by grouping related topics and adding overviews for sections. Update titles for clarity, correcting casing inconsistencies. Split existing entries where applicable to enhance documentation usability.
…cs and Assertions, Optimizers, and updating Signatures. Remove redundant entries and clarify module organization. Adjust typo in "Retreive" to "Retrieve" and make minor formatting changes.
- Revise title to "# DSPy" in intro.md - Add `hide` options for table of contents and navigation in intro.md - Integrate new navigation features in mkdocs.yml for improved user experience
|
@ammirsm the redirects are kept for a reason because those links are used in different websites ,which are giving 404 error. It was creating lot of confusion when user were accessing them . for example this below link have found it on some website of vector database ,which isn't accessible,because the file name has changed to"Signatures" and it is not accessible https://dspy-docs.vercel.app/docs/building-blocks/signatures @okhat the redirects shouldn't be removed for other docs also |
|
@sushmanthreddy Yes good point we want the redirects as long as they're correct |
…es using DSPy and development setup. Update navigation in mkdocs.yml to reflect new content and improve organization.
Expand the `redirects` section in `mkdocs.yml` by adding multiple redirect mappings to streamline navigation across various documentation sections, including Quick Start, Building Blocks, Tutorials, and Deep Dive topics.
# Conflicts: # docs/mkdocs.yml
- Change title from "DSPy Use Cases" to "Use Cases" - Add a detailed table of use cases from various companies, including links to relevant blogs and articles - Update mkdocs.yml to rename "Tutorials" to "Community Resources" under the Community section
ammirsm
changed the title
Create new markdown files for community resources and use cases highlighting helpful blogs, tutorials, videos, and company applications of DSPy. Update the contribution guidelines to include a note on development setup and remove the outdated reference in the navigation file. Adjust project dependencies by removing the unnecessary `json-repair` entry.
This pull request includes several updates to the documentation and configuration of the DSPy project. The most significant changes involve the addition of new community resources, restructuring of the documentation, and updates to dependencies.
Documentation Updates:
docs/docs/community/community-resources.md: Added a comprehensive list of tutorials, blogs, videos, and podcasts related to DSPy. This includes various links to external resources and a call for community contributions.docs/docs/community/how-to-contribute.md: Added a section on development setup and contribution guidelines, encouraging community members to contribute modules or optimizers and providing links to walkthroughs for adding custom language model clients.docs/docs/community/use-cases.md: Created a new document listing various use cases of DSPy in companies and research papers, as well as repositories using DSPy. This aims to showcase practical applications and encourage community contributions.docs/mkdocs.yml: Restructured the navigation to improve the organization of the documentation. This includes changes to the sidebar and the addition of new sections such as "Community" and "Components." [1] [2]Dependency Updates:
pyproject.toml: Removed thejson-repairdependency from the project dependencies list. [1] [2]This pull request includes extensive updates to the documentation of DSPy, focusing on improving the organization and adding new sections for better clarity and usability. The main changes include the addition of new guides, restructuring of the navigation, and updates to community resources.Documentation Enhancements:
docs/docs/community/development-setup.md: Added a new section for development setup instructions.docs/docs/community/how-to-contribute.md: Added a new section on contributing, including guidelines for adding new modules or optimizers and setting up custom LM and RM clients.docs/docs/community/related-projects.md: Added a comprehensive list of use cases, papers, repositories, and integrations related to DSPy.docs/docs/community/tutorials.md: Added a new section listing tutorials and blog posts on DSPy, including blogs, videos, and podcasts.docs/docs/tutorials/debugging.md: Added a new debugging guide to help users troubleshoot common issues with DSPy programs.Navigation and Structural Changes:
docs/mkdocs.yml: Restructured the navigation to improve the organization of the documentation, including renaming and reordering sections, and adding new community resources and debugging sections. [1] [2] [3] [4]Minor Adjustments:
docs/docs/faqs.md: Removed redundant contributing information.docs/docs/intro.md: Updated the intro file to hide the table of contents and navigation.[ Copilot generated ]