Naova K1 Project Documentation#

K1 robot standing

This documentation gathers the projects developed within Naova.

If you want to add your own project to the documentation, see the How to Contribute section.

Start Here#

To get the full and complete setup:

  1. Ask a repository admin to add your GitHub account to our organization.

  2. Ensure your SSH key is added to GitHub. , then verify access with:

    ssh -T git@github.com
    

    See Installation for detailed setup instructions.

  3. If you need internal documentation, make sure you have access to the private wiki repository.

    Note

    Our documentation is maintained in two repositories:

    The private wiki is mainly for projects in development. It is the more complete and current source of documentation.

    If you have not cloned the private wiki repository yet, clone it:

    git clone git@github.com:Naova/NaovaPrivateWiki.git
    
  1. Update your local copy regularly to stay in sync with the latest changes:

    cd NaovaPrivateWiki
    git pull origin main
    
  2. Build the documentation locally to access it offline and see the latest updates:

    ./naova.sh
    
  3. Follow the installation guide to complete your local setup: Installation.

  4. Use How to Contribute when you are ready to add or update documentation.

Documentation Map#

Core Concepts

License#

Naova project documentation is open-source and distributed under the BSD-3-Clause license. For details, see BSD 3-Clause License.

Acknowledgements#

Thanks to all Naova members for their contributions. For the full list of project contributors, see CONTRIBUTORS.md.