docs: restructure navigation and fix code formatting #1191
Merged
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
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
- Move all client docs from /hub/clients/ to /integrations/ - Update mkdocs.yml navigation structure - Add test files for client examples - Document streaming limitations - Add .env.tests for missing API keys - Clean up old client documentation files Link to Devin run: https://preview.devin.ai/devin/89a9e436607c4cbea0bf1a301d3168a5
- Add llama wrapper for testing - Add setup.py for test dependencies - Improve error handling in Fireworks client
- Remove unused imports - Update type annotations to modern syntax - Replace assert False with raise AssertionError - Use _ for unused loop variables
- Remove test_clients directory as requested - Remove test_results.md and streaming_support.md - Focus PR on documentation changes only
- Remove llama_wrapper.py (test infrastructure) - Remove setup.py (test dependencies) - Remove .env.tests - Restore client_fireworks.py to main version - Keep only documentation changes
…itles and add redirect maps - Remove troubleshooting sections from all integration docs - Remove 'Structured outputs with' prefix from navigation titles - Add redirect maps for moved documentation pages - Clean up documentation structure
…files - Fix relative paths in open_source.md and pydantic-is-still-all-you-need.md - Add missing concept documentation (iterable.md, unions.md, validation.md) - Add integrations index page - Update documentation structure
- Replace relative CHANGELOG.md links with absolute GitHub repository links - Update all integration documentation files to use correct CHANGELOG link
- Add #literals anchor for Literals section - Add #chain-of-thought anchor for Chain of Thought section - Fix broken links from examples/classification.md
- Change Zero Shot and Few Shot headings from h4 to h2 - Add #zero-shot-1 and #few-shot-1 anchor IDs - Fix broken links in table of contents
- Change absolute link /cosp.md to relative path ../cosp.md - Fix broken link to Consistency Based Self Adaptive Prompting
… text description
Deploying instructor-py with
|
| Latest commit: |
a16efd7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1100fc98.instructor-py.pages.dev |
| Branch Preview URL: | https://docs-fix-nav-issues.instructor-py.pages.dev |
github-actions
bot
added
documentation
jxnl
reviewed
Nov 18, 2024
mkdocs.yml
Outdated
| - OpenAI: 'integrations/openai.md' | ||
| - Together: 'integrations/together.md' | ||
| - Vertex AI: 'integrations/vertex.md' | ||
| - Single Classification: 'integrations/single_classification.md' |
There was a problem hiding this comment.
the non llm clients should be part of hub
- Single Classification: 'integrations/single_classification.md'
- Bulk Classification: 'integrations/multiple_classification.md'
- Extracting Tables: 'integrations/tables_from_vision.md'
- Creating Pandas DataFrames: 'integrations/pandas_df.md'
- Bulk Async Classification with LangSmith: 'integrations/batch_classification_langsmith.md'
- Extracting Action Items: 'integrations/action_items.md'
- Implementing Partial Streaming Responses: 'integrations/partial_streaming.md'
- Extracting Contact Information: 'integrations/extract_contact_info.md'
- Generating Knowledge Graphs: 'integrations/knowledge_graph.md'
- Extracting Relevant Clips from YouTube Videos: "integrations/youtube_clips.md"
mkdocs.yml
Outdated
| @@ -286,12 +304,45 @@ plugins: | |||
| - redirects: | |||
| redirect_maps: | |||
| jobs.md: https://jobs.applied-llms.org/ | |||
| hub/single_classification.md: integrations/single_classification.md | |||
There was a problem hiding this comment.
hub/single_classification.md: integrations/single_classification.md
hub/multiple_classification.md: integrations/multiple_classification.md
hub/tables_from_vision.md: integrations/tables_from_vision.md
hub/pandas_df.md: integrations/pandas_df.md
hub/batch_classification_langsmith.md: integrations/batch_classification_langsmith.md
hub/action_items.md: integrations/action_items.md
hub/partial_streaming.md: integrations/partial_streaming.md
hub/extract_contact_info.md: integrations/extract_contact_info.md
hub/knowledge_graph.md: integrations/knowledge_graph.md
hub/youtube_clips.md: integrations/youtube_clips.md
should be in hub
- Remove duplicate redirects - Organize redirects into sections for hub/ and legacy hub/clients/ - Keep all LLM client documentation redirects - Add redirect for old vertexai.md references
- Remove unused imports - Update List[str] to list[str] - Mark unused parameters as keyword-only arguments
- Add type ignores for mkdocs imports - Prefix unused parameters with underscore to satisfy Ruff - Update docstring to reflect parameter usage
- Fix import ordering according to Black's style - Add consistent newlines between code sections - Fix spacing around class definitions and function calls - Ensure proper formatting in all code examples
- Add missing legacy hub/clients/ redirects for all LLM providers - Ensure proper redirection for all old documentation paths - Maintain consistent redirect structure across all integrations
- Remove trailing whitespace - Fix quote style consistency - Improve code block formatting and indentation - Fix line wrapping in comments
devin-ai-integration
bot
changed the title
- Fix Python type hints in version-1.md to use modern syntax - Fix JSON formatting and trailing whitespace in rag-timelines.md - Ensure Black formatting compliance in code blocks
- Fix model name in pairwise-llm-judge.md - Remove extra comma in messages list - Fix comment formatting - Improve JSON structure and indentation - Ensure consistent formatting across code examples
|
Devin is currently unreachable - the session may have died. |
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.
Documentation Structure and Formatting Updates
This PR includes several improvements to the documentation structure and formatting:
Changes
Navigation Structure
Code Formatting
Documentation Quality
Testing
Link to Devin run: https://preview.devin.ai/devin/89a9e436607c4cbea0bf1a301d3168a5
Related Issues
Fixes formatting issues in documentation code blocks and completes the navigation restructuring.