diff --git a/docs/index.md b/docs/index.md index 5070dd8..d495af9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,12 +9,15 @@ Header -This library was inspired by [onshape-to-robot](https://github.com/Rhoban/onshape-to-robot), a tool renowned for its streamlined approach to URDF generation. While onshape-to-robot library focuses on predefined workflows and design-time considerations, the `onshape-api` library offers greater flexibility. It provides access to nearly all of Onshape's REST API calls, enabling headless manipulation, detailed analysis, and seamless export of CAD assemblies. Users can programmatically edit variable studios, generate graph-based visualizations, and export URDF files tailored to their specific needs—all without being restricted by rigid workflows or naming conventions. By removing these constraints, the `onshape-api` library empowers the robotics and CAD communities to create custom solutions for algorithmic design, optimization, and automation. +  +This library was inspired by onshape-to-robot, a tool renowned for its streamlined approach to URDF generation. While onshape-to-robot library focuses on predefined workflows and design-time considerations, the `onshape-api` library offers greater flexibility. It provides access to nearly all of Onshape's REST API calls, enabling headless manipulation, detailed analysis, and seamless export of CAD assemblies. Users can programmatically edit variable studios, generate graph-based visualizations, and export URDF files tailored to their specific needs—all without being restricted by rigid workflows or naming conventions. By removing these constraints, the `onshape-api` library empowers the robotics and CAD communities to create custom solutions for algorithmic design, optimization, and automation. +   # Key Features of `onshape-api` The `onshape-api` library is designed for users seeking a scalable, versatile API that empowers innovative robot design and control workflows. By integrating Onshape into algorithmic processes such as design optimization and automation, it unlocks the full potential of Onshape's cloud-based CAD system, fostering creativity and efficiency in robotics and beyond. +   | Feature | `onshape-api` | `onshape-to-robot` | @@ -32,9 +35,9 @@ The `onshape-api` library is designed for users seeking a scalable, versatile AP Before you begin, ensure you have the following: -- [Python 3.10](https://www.python.org/downloads/release/python-3100/) or higher installed on your machine. -- [An Onshape account](https://www.onshape.com/en/) if you don't already have one. -- [Onshape API keys (access key and secret key)](https://onshape-public.github.io/docs/auth/apikeys/) +- Python 3.10 or higher installed on your machine. +- An Onshape account if you don't already have one. +- Onshape API keys (access key and secret key) ## Installation diff --git a/docs/tutorials/edit.md b/docs/tutorials/edit.md index f27ea38..2239fa8 100644 --- a/docs/tutorials/edit.md +++ b/docs/tutorials/edit.md @@ -14,7 +14,7 @@ Before you begin, make sure you have: ``` - **API Keys**: Set up your Onshape API keys in a `.env` file as outlined in the [Getting Started](../getting-started.md) guide. - **Access to the Onshape Document**: Use a CAD document with a Variable Studio. For this tutorial, we’ll use the following example: - [Example CAD Document](https://cad.onshape.com/documents/a1c1addf75444f54b504f25c/w/0d17b8ebb2a4c76be9fff3c7/e/a86aaf34d2f4353288df8812). + Example CAD Document. --- diff --git a/docs/tutorials/export.md b/docs/tutorials/export.md index f85da3f..7376ad0 100644 --- a/docs/tutorials/export.md +++ b/docs/tutorials/export.md @@ -16,7 +16,7 @@ Before you begin, ensure the following: ``` - **API Keys**: Set up your Onshape API keys in a `.env` file. Refer to the [Getting Started](../getting-started.md) guide if needed. - **Document URL**: Have the URL of the Onshape assembly you want to convert. For this example, we’ll use: - [Arbor Press Assembly](https://cad.onshape.com/documents/00fdecd70b9459267a70825e/w/5b8859e00b5d129724548da1/e/8bb8553f756c40770e11d5b4). + Arbor Press Assembly. ---