The Wayback Machine - https://web.archive.org/web/20200615141039/https://github.com/topics/robocup
Skip to content
#

robocup

Here are 139 public repositories matching this topic...

jgkamat
jgkamat commented Jan 31, 2017

Right now the RRT has much less documentation than I'd like (the RRT is one of the most useful parts of our codebase, since it's modularized). We need to try to make thorough docs for the rrt.

Once we have most of the way done to this, I'll add documentation generation so we can have a RRT docs site we can link to on our README, just like robocup-software and robocup-firmware.

This is a goo

rfairley
rfairley commented Jan 12, 2019

Describe the feature
This adds documentation as comments to functions, classes, namespaces, files, etc. throughout the code using doxygen macros.

Remove unit tests from documentation (as discussed today).

Relevant items from (#121):

Remove names after @file in Doxygen
Reason: Apparently we do not actually need any name after this tag, so we should just remove it using a script

Finchiedev
Finchiedev commented Jan 29, 2020

When new users encounter the GUI, they may be overwhelmed and not know what to. To counter this, I propose the integration of Intro.js. After they have read the documentation on core concepts, the Intro.js framework could tour them around the software so they have a general idea of what's going on.

This walkthrough should be accessible through the 'help' menu & when Robo

Improve this page

Add a description, image, and links to the robocup topic page so that developers can more easily learn about it.

Curate this topic

Add this topic to your repo

To associate your repository with the robocup topic, visit your repo's landing page and select "manage topics."

Learn more

You can’t perform that action at this time.