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

Refactor packages: write docs #1290

Closed
2 tasks done
josecelano opened this issue Feb 18, 2025 · 4 comments · Fixed by #1337
Closed
2 tasks done

Refactor packages: write docs #1290

josecelano opened this issue Feb 18, 2025 · 4 comments · Fixed by #1337
Assignees
@josecelano
Labels
- Developer - Torrust Improvement Experience Documentation Improves Instructions, Guides, and Notices

Comments

@josecelano
Copy link
Member

josecelano commented Feb 18, 2025 •
edited
Loading

Add a README.md to the directory packages explaining app architecture.

  • Add a table with package name, crate name, description (what should be included in that package), examples.
  • Add a Miro diagrams with the app layers.

The diagram can be similar to the following one but only with layers (without including functions calls)

Image
@josecelano josecelano added - Developer - Torrust Improvement Experience Documentation Improves Instructions, Guides, and Notices labels Feb 18, 2025
@josecelano josecelano self-assigned this Feb 18, 2025
@josecelano
Copy link
Member Author

I've done this diagram to show dependencies between packages:

Image

I think it's not very useful. I will split it into 4 diagrams, one for each service:

  • HTTP tracker
  • UDP tracker
  • Tracker API
  • Health Check API

And maybe, a simpler layers diagram could be clearer.

cc @da2ce7

@josecelano
Copy link
Member Author

I've created one diagram only for the packages needed to run the UDP server:

Image

I think this is better. I can create one for each service (UDP tracker, HTTP tracker, Tracker REST API, Health Check API).

@josecelano
Copy link
Member Author

And this is a simplification omitting secondary packages:

Image

@josecelano
Copy link
Member Author

Another example with all services, layers and main packages:

Image

@torrust/torrustaceans

josecelano added a commit to josecelano/torrust-tracker that referenced this issue Mar 3, 2025
@josecelano
docs: [torrust#1290] add documentation for packages
4ee9def
@josecelano josecelano linked a pull request Mar 3, 2025 that will close this issue
Refactor packages: write docs #1337
Merged
josecelano added a commit to josecelano/torrust-tracker that referenced this issue Mar 3, 2025
@josecelano
docs: [torrust#1290] add documentation for packages
a8224e8
josecelano added a commit that referenced this issue Mar 3, 2025
@josecelano
Merge #1337: Refactor packages: write docs
d918e47 
b76eff6 fix: clippy error (Jose Celano)
a8224e8 docs: [#1290] add documentation for packages (Jose Celano)

Pull request description:

  Refactor packages: write docs

  Added documentation for pacakges.

ACKs for top commit:
  josecelano:
    ACK b76eff6

Tree-SHA512: 513adb54c9b5435e3fe3438a748ba2571d01f054004e0337635d23a0f16c9bae85fe66b427c99d87a7369a8563e6e6b748bd9854bd94b2130ca16e51be9d675a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@josecelano josecelano

Labels
- Developer - Torrust Improvement Experience Documentation Improves Instructions, Guides, and Notices
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Refactor packages: write docs josecelano/torrust-tracker
1 participant
@josecelano