Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ONAV-1756] Remove api examples beta tag and link the github repo #186

Merged
merged 3 commits into from
Oct 31, 2023
Merged

[ONAV-1756] Remove api examples beta tag and link the github repo #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8505728
remove api examples beta tag and link the github repo
jmastrangelo-cpr Oct 30, 2023
6f338dd
fix link
jmastrangelo-cpr Oct 30, 2023
22b9474
rewording
jmastrangelo-cpr Oct 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs_outdoornav_user_manual/api/api_examples/api_examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 0 additions & 10 deletions docs_outdoornav_user_manual/api/api_examples/mission_from_file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions docs_outdoornav_user_manual/api/api_examples/mission_with_custom_tasks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
10 changes: 0 additions & 10 deletions docs_outdoornav_user_manual/api/api_examples/monitor_status.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down