WIP Docs #272
Closed
WIP Docs #272
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Configure Sweep
…thedocs_integrati Sweep: Set up project for ReadTheDocs integration. (✓ Sandbox Passed)
The Algolia CSS file was removed, impacting the configuration file as well. Moreover, the documentation's structure was heavily updated, removing unnecessary sections and refining existing ones for clarity. Sections related to community and contributions are emphasized now. The standardization of the table of contents and captions was also a prominent part of the update.
The README.rst file is deleted and modules.ipynb file, which explains the use of DSPy modules, is created. The README was removed because the same information was already found in other files, resulting in duplication. The newly added file provides a detailed explanation about the DSPy modules.
The code refactor involves renaming and reorganizing the documentation and tutorial files from 'dspy_constructs' folders to 'guides' and 'api_reference' folders respectively. This makes the documentation more understandable and easier to navigate. In the process, redundant README files were also removed to eliminate unnecessary duplication.
The commit removes a redundant README file from the 'getting_started' folder and renames the existing README. The documentation structure has also been adjusted, moving files from 'getting_started' to 'guides' and 'api_reference', enhancing clarity and usability.
fix(index.rst): update link to Getting Started Guide in index.rst
… assertions guide
This commit removes two `anyscale.md` and `cohere.md` files from the `docs/api_reference/language_models/hosted` directory and `intro.ipynb` file from the 'getting_started/beginner' directory. These files were causing redundancy in the API reference documentation.
…re temporarily docs(Retrieve.md): delete Retrieve.md file as it is no longer needed
This commit eliminates five language model guide docs and makes necessary adjustments to the '.gitignore' file. The redundant documents were relating to the launching of MLP, TGI, and vLLM servers, as well as metrics and retrieval models. This streamlines the project's documentation structure for clarity.
… the new naming convention docs(api_reference/modules): remove unnecessary sections and examples docs(api_reference/modules): add TODO comment to indicate that further changes are needed docs(index.rst): update path to tutorials docs(tutorials/tuts.md): create new file with introductory text for tutorials
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.