{"id":31953233,"url":"https://github.com/ubiquityrobotics/learn2","last_synced_at":"2025-10-14T13:42:32.288Z","repository":{"id":312871931,"uuid":"1049075428","full_name":"UbiquityRobotics/learn2","owner":"UbiquityRobotics","description":"Official repository for Ubiquity Robotics Documentation","archived":false,"fork":false,"pushed_at":"2025-09-25T12:49:04.000Z","size":56922,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-25T13:07:46.559Z","etag":null,"topics":["documentation","robot","robotics","ros2","ubiquity-robotics"],"latest_commit_sha":null,"homepage":"https://ubiquityrobotics.github.io/learn2/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UbiquityRobotics.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-02T12:59:51.000Z","updated_at":"2025-09-19T13:29:07.000Z","dependencies_parsed_at":"2025-09-02T15:26:57.396Z","dependency_job_id":"a761f90d-d042-4d52-a2d0-0e1fae6df2fb","html_url":"https://github.com/UbiquityRobotics/learn2","commit_stats":null,"previous_names":["ubiquityrobotics/learn2"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/UbiquityRobotics/learn2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UbiquityRobotics%2Flearn2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UbiquityRobotics%2Flearn2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UbiquityRobotics%2Flearn2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UbiquityRobotics%2Flearn2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UbiquityRobotics","download_url":"https://codeload.github.com/UbiquityRobotics/learn2/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UbiquityRobotics%2Flearn2/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279018720,"owners_count":26086613,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","robot","robotics","ros2","ubiquity-robotics"],"created_at":"2025-10-14T13:42:29.056Z","updated_at":"2025-10-14T13:42:32.283Z","avatar_url":"https://github.com/UbiquityRobotics.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ubiquity Robotics Gen 6 Documentation\n\nThis repository contains the source files for the documentation by Ubiquity Robotics. It is built using [Sphinx](https://www.sphinx-doc.org/) and styled using the [Read the Docs](https://github.com/readthedocs/sphinx_rtd_theme) theme. The documentation is deployed via [Github Pages](https://pages.github.com/).\n\n## Overview\n\nThe site hosts technical documentation for Ubiquity Robotics robots, covering hardware, usage guides, software images, and systems software. \n\n- Each branch corresponds to a version of the documentation.\n- Development branches (suffix `-devel`) are used for testing changes before they are pushed to the main documentation. \n- Feature branches (prefix `feature/`) are ignored in the version selector and are used for working on specific updates or improvements.\n\n## Deployment\n\nThe documentation is built and deployed automatically using GitHub Actions. The latest version is available at:\n\n\u003c!-- TODO: Change this to the actual website when the repo is switched. --\u003e\n**[https://paveljolak.github.io/learn2/](https://paveljolak.github.io/learn2/)**\n\n## Local Development\n\nTo build and run the documentation locally:\n\n\u003c!-- TODO: Add the right links and names for cloning the repository. --\u003e\n```bash\ngit clone https://github.com/Paveljolak/learn2.git\ncd learn2\ngit fetch --all\ngit branch -a\n\npython3 -m venv venv # Run this only the first time you clone the repo.\nsource venv/bin/activate  # Windows: venv\\Scripts\\activate\n\n# Install latest compatible dependencies:\npip install -r required_packages.txt # Run this only the first time you clone the repo\n\n# Enter which version you want to see\ngit checkout [version_name]\n\n# or\n# git switch [version_name]    # git added the \"git switch\" command now to switch branches\n\n# Get into docs directory\ncd docs/\n\n# Build the documentation \nmake clean \u0026\u0026 make html \n\n# Open in browser\nfirefox _build/html/index.html\n\n---- \n# (Optional - Requires sphinx-autobuild)\n# pip install sphinx-autobuild\n\n# run next command from inside docs directory:\nsphinx-autobuild . _build/html # autobuilds the site on local save. It serves it locally on port 8000. \n# [sphinx-autobuild] Serving on http://127.0.0.1:8000\n\n\n---- \n# (Optional local run) - Requires python server\n\n# From root of repository:\ncd docs/_build/html/\n\n# Start the server\npython3 -m http.server 8000 \n\n# Now you can see the documentation at http://0.0.0.0:8000/\n# of course this port can be also changed to a different number than 8000.\n\n# NOTE: Locally you can only see a single version, and will not be able to switch between versions without switching the branch and re-building.\n\n\n```\n\n\u003e **NOTE**: Some images will show locally some will not. This is because we are hosting on GitHub pages, GitHub may look for the pictures in some other place and the relative path might not work when deployed. This is the case when having multiple in-line pictures.\n\n\n## Contributing\n\nThe easiest way to contribute to the documentation is by forking or cloning the repository.\n\n### Branching Rules\n\n- **Development branches**: All changes should be pushed to branches ending with `-devel`. \n- **Creating new versions**: Only create a new branch if you are adding a completely new version. These branches will appear in the deployed version selector. \n- **Updating existing versions**: Createa a feature branch from the corresponding `-devel` branch. Feature branches should follow this naming convention: \n\n```bash \n\nfeature/[version]-[feature-name]\n\n```\n\nThis ensures: \n\n1. The branch does not appear as a version in the deployed site. \n2. Others can easily see which version and feautre you are working on. \n\nOnce your feature is ready, merge it into the respective `-devel` branch. \nAfter verifying everything works, it can then be merged into the actual version branch. \n\n\u003e **IMPORTANT**: This workflow helps avoid conflicts, especially since some images or embeddings may render differently locally versus after deployment.\n\n### Workflow for Contributing\n\nAssuming you have already cloned the repository locally:\n\n```bash\n\n# Switch to the version's development branch\ngit switch [version_name]-devel\n\n# Create a new feature branch\ngit checkout -b feature/[version_name]-[feature-name]\n\n# Make your changes, then commit and push\ngit add .\ngit commit -m \"Meaningful commit message here\"\ngit push -u origin feature/[version_name]-[feature-name]\n\n```\n\nAfter pushing:\n\n1. Open a pull request on GitHub to merge your feature branch into the correspnding `-devel` branch. \n2. Once merged, wait for the GitHub workflow to build and deploy your changes.\n3. Verify the deployed site to ensure your changes appear correctly.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubiquityrobotics%2Flearn2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fubiquityrobotics%2Flearn2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubiquityrobotics%2Flearn2/lists"}