Skip to content

DOC: User and Development docs for TAGI. - #5

Open
diogoalvessoares wants to merge 4 commits into
developfrom
doc/tagi-documentation
Open

diogoalvessoares wants to merge 4 commits into
developfrom
doc/tagi-documentation

Conversation

@diogoalvessoares

@diogoalvessoares diogoalvessoares commented May 8, 2026

Copy link
Copy Markdown
Collaborator

Notes

  • New features
  • Bug fixes
  • Documentation
  • Maintenance
  • Tests
  • Design

Old behaviour

  • readme: had information of the robot mixed with the robot documentation.

New behaviour

  • readme: only has an initial information about the robot, for now;
  • docs: added documentation for TAGI.
    -> The docs/ features two different folders:
    --> docs/dev:
    ---> develop_in_tagi: Best guide for people that want to begin developing in TAGI;
    ---> middleware: Documentation about what the middleware.py is about;
    ---> python_api: Python API;
    ---> rest_api: Rest API;
    ---> scripts: Documentation for what each of the scripts available on elmo-v2/scripts does;
    ---> setup: Documentation for how to configure RPI 5.
    --> docs/user:
    ---> behaviour_usage: Quick guide on how to interact with TAGI;
    ---> first_usage: TAGI First usage instructions.
  • Technical Documentation for all existing /src files in the current private IDMind repo version.
Note: For existing changes, yet also part of the REPO src/ files, or not, their Technical Documentation has been added in their respective pull request, requiring moving to them in order to see it.

@diogoalvessoares
diogoalvessoares requested a review from a team May 8, 2026 11:07
@LVGoncalves LVGoncalves changed the title DOCUMENTATION: Documentation for TAGI. DOC: User and Development docs for TAGI. May 8, 2026
@LVGoncalves

Copy link
Copy Markdown
Collaborator

Hello Diogo! Awesome implementation.
Could you also add a good clean up on the README file for the repository, since most information there is now organized on the docs you developed?
Thanks.

@diogoalvessoares

diogoalvessoares commented May 9, 2026

Copy link
Copy Markdown
Collaborator Author

Hello Lucas.
Thanks for the compliment.
Would you like for me to create a new branch for this? Or would you want me to create a new branch called "doc/update-readme", "doc/readme"?
Please let me know what works better for you!! I'll be working on starting a fresh README in the meantime.

Regards,

Diogo.

@LVGoncalves

Copy link
Copy Markdown
Collaborator

Hello Lucas. Thanks for the compliment. Would you like for me to create a new branch for this? Or would you want me to create a new branch called "doc/update-readme", "doc/readme"? Please let me know what works better for you!! I'll be working on starting a fresh README in the meantime.

No need for over-complication. Just delete the material on the README so it is just an introduction to Tagi.

@diogoalvessoares

Copy link
Copy Markdown
Collaborator Author

On it!

@diogoalvessoares

diogoalvessoares commented May 11, 2026

Copy link
Copy Markdown
Collaborator Author

Hello,

I have made some changes recently. They have taken effect. Tell me if you need anything else on this branch.

Regards,

Diogo.

@diogoalvessoares

diogoalvessoares commented May 14, 2026

Copy link
Copy Markdown
Collaborator Author

Hello Lucas,

Check the newest commit and the update to the pull request information, very important.

Regards,

Diogo.

@LVGoncalves LVGoncalves added the documentation Improvements or additions to documentation label Jul 2, 2026
Comment thread src/driver_pan_tilt.py
"""
pan_id = self.pan.id
tilt_id = self.tilt.id
hx.connect("/dev/serial0", 115200)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to double check why this change was done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants