Rock Robotic Docs

View the Rock Robotic Docs.

This is a repo containing all Rock Robotic docs. Rock Docs uses Material for MkDocs. MkDocs is a static site generator geared towards (technical) project documentation.

Visit the Rock Robotic site or our Community site for more information.

Contributing

Review the Getting Started Guide to get spun up quickly. If there's a change you would like to make to the documentation please Fork the repository and issue a Pull Request.

Quick Commands

1. Get the Docker container. docker pull arknoll/mkdocs

2. Build mkdocs. docker run --rm -it -p 8000:8000 -v ${PWD}:/docs arknoll/mkdocs

3. Serve documentation without a server.

• In mkdocs.yml add use_directory_urls: false
• Run docker run --rm -it -v ${PWD}:/docs arknoll/mkdocs build

CI/CD

We use GitHub Actions to build the static site. Once built, the static site is committed to the gh-pages branch.