diff --git a/docs_outdoornav_user_manual/api/api_examples/api_examples.mdx b/docs_outdoornav_user_manual/api/api_examples/api_examples.mdx index e123509b..32daf5e7 100644 --- a/docs_outdoornav_user_manual/api/api_examples/api_examples.mdx +++ b/docs_outdoornav_user_manual/api/api_examples/api_examples.mdx @@ -6,13 +6,15 @@ toc_min_heading_level: 2 toc_max_heading_level: 4 --- -:::info +The OutdoorNav API examples are now available and accesible to everyone. A +[Python API library](https://github.com/cpr-application/clearpath_onav_examples) along +with some example scripts are available to build and use for our application. -The API Examples section is currently in BETA. That is, we are providing instructions and examples of how to -generate your own example scripts using our API, however not everyone will be able to run these -scripts. During the BETA release of this feature, only a select few partners will be eligible to -run their custom example scripts. Full access/release of this feature will be available in version 0.10.0 -(estimated Nov. 2023). +A few examples scripts follow with detailed explanations: -::: +- [Execute Mission from File](./mission_from_file.mdx) +- [Execute Mission with Custom Task](./mission_with_custom_tasks.mdx) +- [Status Monitoring](./monitor_status.mdx) +The documentation for the Python API library can be built following the +instructions in the above linked GitHub repository. diff --git a/docs_outdoornav_user_manual/api/api_examples/mission_from_file.mdx b/docs_outdoornav_user_manual/api/api_examples/mission_from_file.mdx index 2c80b317..eff0f768 100644 --- a/docs_outdoornav_user_manual/api/api_examples/mission_from_file.mdx +++ b/docs_outdoornav_user_manual/api/api_examples/mission_from_file.mdx @@ -6,16 +6,6 @@ toc_min_heading_level: 2 toc_max_heading_level: 4 --- -:::info - -API examples are currently in BETA. That is, we are providing instructions and examples of how to -generate your own example scripts using our API, however not everyone will be able to run these -scripts. During the BETA release of this feature, only a select few partners will be eligible to -run their custom example scripts. Full access/release of this feature will be available in version 0.10.0 -(estimated Nov. 2023). - -::: - ## The Code ``` python diff --git a/docs_outdoornav_user_manual/api/api_examples/mission_with_custom_tasks.mdx b/docs_outdoornav_user_manual/api/api_examples/mission_with_custom_tasks.mdx index 9a4a4efd..30ec477e 100644 --- a/docs_outdoornav_user_manual/api/api_examples/mission_with_custom_tasks.mdx +++ b/docs_outdoornav_user_manual/api/api_examples/mission_with_custom_tasks.mdx @@ -6,16 +6,6 @@ toc_min_heading_level: 2 toc_max_heading_level: 4 --- -:::info - -API examples are currently in BETA. That is, we are providing instructions and examples of how to -generate your own example scripts using our API, however not everyone will be able to run these -scripts. During the BETA release of this feature, only a select few partners will be eligible to -run their custom example scripts. Full access/release of this feature will be available in version 0.10.0 -(estimated Nov. 2023). - -::: - Before being able to run the examples similar to the one explained below, it is required that you have written your own custom tasks. See the [Custom Tasks](../../features/custom_tasks.mdx) section for information on how to develop tasks for your application. diff --git a/docs_outdoornav_user_manual/api/api_examples/monitor_status.mdx b/docs_outdoornav_user_manual/api/api_examples/monitor_status.mdx index 8aeb3ca8..077a9fcf 100644 --- a/docs_outdoornav_user_manual/api/api_examples/monitor_status.mdx +++ b/docs_outdoornav_user_manual/api/api_examples/monitor_status.mdx @@ -6,16 +6,6 @@ toc_min_heading_level: 2 toc_max_heading_level: 4 --- -:::info - -API examples are currently in BETA. That is, we are providing instructions and examples of how to -generate your own example scripts using our API, however not everyone will be able to run these -scripts. During the BETA release of this feature, only a select few partners will be eligible to -run their custom example scripts. Full access/release of this feature will be available in version 0.10.0 -(estimated Nov. 2023). - -::: - ## The Code ``` python