WIP refactor of the Python SDK documentation #9116
Closed
Conversation
This file contains hidden or 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
…rove its clarity and structure.
Here's a summary of the key changes:
- **New Directory Structure**: I've organized all Python-related documentation under `docs/integrations/python/`.
- **Central Landing Page**: The `python.md` file now serves as an overview. It links to detailed pages for each SDK/tool and includes a "Common Use Cases" section for you.
- **Dedicated SDK/Tool Pages**: I've created separate pages for the High-Level SDK (`high_level_sdk.md`), Generated SDK (`generated_sdk.md`), `lakefs-spec` (`lakefs_spec.md`), and Boto3 (`boto3.md`).
- **Standardized Page Structure**: Each SDK/tool page now follows a consistent structure to help you find information:
- Overview: Description, key features, installation, initialization.
- Tutorials/User Guides: Step-by-step examples with improved error handling.
- Link to the new Best Practices guide.
- **New Best Practices Guide**: I've added a new page (`best_practices.md`) which provides:
- Guidance on choosing the right Python tool for your needs.
- Performance considerations for various operations.
- General error handling patterns.
- Security best practices.
- **Improved Examples**: I've reviewed the code examples across all pages to ensure they are clear, robust (including error handling), and accurate.
- **Navigation**: I've updated the front matter to ensure correct hierarchical navigation within the "just-the-docs" theme. I've also verified all internal links.
My goal with this refactoring was to make the Python documentation more accessible, user-friendly, and easier for you to use, incorporating feedback for a more structured and task-oriented guide.
|
|
|
🎊 PR Preview d00a725 has been successfully built and deployed to https://treeverse-lakeFS-preview-pr-9116.surge.sh 🕐 Build time: 0.011s
🤖 By surge-preview |
nopcoder
added
docs
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.