The docs are powered by VitePress. The website is deployed by a GitHub action on every push to the master branch.

Install Node.js. We recommend the latest LTS version (as for now it's 22). Here is how to do it on Ubuntu:

# Setup the local Ubuntu repository
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E sh -

# Install Node.js
sudo apt-get install nodejs -y

# Install dependencies specified in package.json (Run in auto-apms-guide directory)
npm install

For further information, visit the quickstart guide for setting up VitePress.

The project is scaffolded from the root of this repository and supports the following commands:

• Run npm run dev for starting the dev server
• Run npm run build for generating the static HTML site
• Run npm run preview to preview the production build
• Run npm run lint to lint the markdown
• Run npm run lint-fix to lint AND fix the markdown formatting

• create_full_tree_node_reference.sh

  Generate the markdown file that is used to display the behavior tree node reference page. This script requires a valid AutoAPMS workspace for parsing the builtin nodes.

  # Must be executed from repository root
  ./script/create_full_tree_node_reference.sh /path/to/auto-apms/workspace