Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation of current state 2024 #36

Open
afr2903 opened this issue Nov 20, 2024 · 0 comments
Open

Documentation of current state 2024 #36

afr2903 opened this issue Nov 20, 2024 · 0 comments

Comments

@afr2903
Copy link
Member

afr2903 commented Nov 20, 2024

Documentation of current state 2024

Based on the ROS nodes to be executed for the different tasks, clear and thorough documentation should be generated, including the purpose of the area in the service robot and further explanation of the technologies used, with examples.

This is the overview of the robot and the area:

Achievements from 2024

This year, after being accepted to participate in RoboCup 2024 held in Eindhoven, Netherlands, the team focused in developing a robust and reliable set of software modules, tailored to the specific needs for the tasks for the updated rulebook. This approach, had the purpose of showcasing a functional robot for both the Mexican Robotics Tournament (April; Monterrey, Mexico) and the RoboCup (July; Eindhoven, Netherlands).

The robot was renamed as FRIDA (Friendly Robotic Interactive Domestic Assistant), an acronym reflecting the purporse of the robot, and the name in reference to Mexican culture.

With the vast knowledge acquired during the international tournament, the team defined the new objectives for the remainder of the year to be: an increased focus in research and literature review, and centralized and offline refactorization of the software and systems.
afr2903 added a commit that referenced this issue Nov 20, 2024
@afr2903
Add documentation for current state 2024
d300d70 
Fixes #36

Add detailed documentation for the current state of the project in 2024.

* **README.md**:
  - Add an overview and introduction section to provide a high-level summary of the project, its purpose, and main components.
  - Add achievements and objectives section to document the achievements from 2024 and the new objectives for the remainder of the year.
  - Add a directory structure section to provide a clear directory structure with explanations for each directory and its purpose.
  - Add a contributing section to include instructions on how to contribute to the project.
  - Add a license section to include the license information for the project.

* **DOCUMENTATION.md**:
  - Add detailed documentation for each ROS node, explaining their purposes, technologies used, and examples.
  - Add examples for basic setup, running the robot, using ROS nodes, launch files, configuration files, scripts, maps and navigation, contributing, and license.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/RoBorregos/home-navigation/issues/36?shareId=XXXX-XXXX-XXXX-XXXX).
@afr2903 afr2903 mentioned this issue Nov 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for current state 2024 RoBorregos/home-navigation
1 participant
@afr2903