Skip to content

Commit

Permalink
0.12.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
jmastrangelo-cpr committed Apr 10, 2024
1 parent 1c3bf68 commit d1b2516
Show file tree
Hide file tree
Showing 71 changed files with 10,183 additions and 7 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,12 @@ Next, to start the development of a new version, the latest released version of

For Example, for making a new release after humble, the contents of `docs_versioned_docs/version-ros2humble/` would be copied to `docs/`. This folder will then be built as the "next" version. Once enabled, this version will be available in the version drop down (just like how it is visible for OutdoorNav - http://docs.clearpathrobotics.com/docs_outdoornav_user_manual/next/index).

Enable the visibility of the "next" version by setting
Enable the visibility of the "next" version by setting

```
includeCurrentVersion: true,
```

in `docusaurus.config.js` alongside `id: "docs",`. Ensure to reset this to false before releasing the changes.

Continue through to step 9 of the workflow above to complete the update. Once complete, continue to the release phase.
Expand Down Expand Up @@ -198,11 +200,11 @@ includeCurrentVersion: false,

5. Empty the docs folder leaving only the .keep file (such that the folder is still tracked by git).

6. When ready, publish your branch on GitHub, and submit a Pull Request to merge your changes into the _development_ branch.
Be sure to include the updates to the following:
- docs_versioned_docs/
- docs_versioned_sidebars/
- docs_versions.json
6. When ready, publish your branch on GitHub, and submit a Pull Request to merge your changes into the _development_ branch.
Be sure to include the updates to the following:
- docs_versioned_docs/
- docs_versioned_sidebars/
- docs_versions.json

</details>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "OutdoorNav User Manual",
"position": 1
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Application Programming Interface",
"position": 7
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "API Endpoints",
"position": 2
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: API Endpoints
sidebar_label: API Endpoints
sidebar_position: 2
toc_min_heading_level: 2
toc_max_heading_level: 4
---

The ROS 1 Noetic API can be used to monitor and manage OutdoorNav Software. Details
are available through the child pages.

- [Platform API](platform_api.mdx)
- [Autonomy API](autonomy_api.mdx)
- [Mission Manager API](mission_manager_api.mdx)
- [Definitions](definitions.mdx)

Loading

0 comments on commit d1b2516

Please sign in to comment.