Add new specklepy documentation files #261
Draft
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
- Updated the VuePress configuration file to include additional sections for the Python SDK and its documentation. - Added new Python documentation files for authentication, core concepts, and getting started with specklepy. - Organized the sidebar navigation to include the new Python sections and their respective child pages.
✅ Deploy Preview for speckle-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
This commit adds a new file `dev/py-howto-collaboration.md` which contains a detailed guide on how to collaborate on projects using Speckle. The guide covers topics such as understanding collaboration in Speckle, setting up a digital workspace, building a team, organizing work with models, tracking changes with versions, real-time collaboration, sharing data within the team and with external stakeholders, common collaboration scenarios, and troubleshooting tips. The guide includes code examples and best practices for each topic to help users effectively collaborate on their projects.
This commit adds a guide on authentication in SpecklePy, covering available methods and providing practical examples. It also introduces the core concepts of base objects, transport system, and units & geometry. The guide explains why these concepts are important and provides code examples to illustrate their usage. Additionally, it includes best practices for secure token storage, minimal scopes usage, revoking unused tokens, and keeping tokens out of source code. Robust error handling is also discussed.
This commit adds new sections to the Python documentation, including topics on working with transports, collaboration, large data, realtime, geometry, and instances. The previous sections on examples and samples have been commented out for now.
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.
I am starting to flesh out a Python set of how-to guides in the developer docs. This will be correct but a little bare bones in view of new-docs site being prepped.