Turtlebot4 User Manual

This repository contains the source code for building the Turtlebot4 User Manual. To view the manual, click here.

Build

To build the Turtlebot4's User Manual locally, first install Ruby version 2.7.7

You can check your ruby the version using:

ruby -v

Ensure that it is showing the correct version.

Using Ruby 3+

Ruby 3+ isn't recommended due to [this issue](https://talk.jekyllrb.com/t/error-no-implicit-conversion-of-hash-into-integer/5890/2). Unfortunately, Ruby 3+ is required for `sass-converter` to be installed; a dependency of jekyll. If you don't want to (or can't) juggle multiple Ruby versions, you can run this patch to fix Ruby 3+ such that it works with Github Pages.

sudo sed -i.bak 's/, kwd/, **kwd/' $(gem which pathutil)

If you get the warning "No version is set for command ruby" then you need to set the active ruby version in asdf:

asdf global ruby 2.7.7

Ensure your Ruby gems are up to date:

gem update --system

Next install Jekyll and the rest of the prerequisites. Be careful to not overwrite the Ruby version.

Clone this repository:

git clone https://github.com/turtlebot/turtlebot4-user-manual.git

Build and start a local server:

cd turtlebot4-user-manual
make
make server

The webpage will now be available at 127.0.0.1:4000