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.

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

Doc/repo nav pages #46

Merged

Conversation

stroncoso-quobis
Copy link
Collaborator

What type of PR is this?

Add one of the following kinds:

  • cleanup
  • documentation

What this PR does / why we need it:

To improve repository navigation, attract developers and define clear focus on documentation usability

Which issue(s) this PR fixes:

none

Special notes for reviewers:

Live preview of API using redoc and swagger in combination with UML pre-rendered images will significan improve the legibility of the repository and the API itself

Changelog input

task(doc): Clean and updated README files
task(doc): Include PNG render of UML diagrams
task(doc): Include readme for UML diagrams folder

Additional documentation

n/a

Copy link
Collaborator

@TEF-RicardoSerr TEF-RicardoSerr left a comment

Choose a reason for hiding this comment

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

Looks so good! Great job Santi!

Im approving it and we can merge it after next meeting

@stroncoso-quobis
Copy link
Collaborator Author

Please, @hdamker , @sushanthmavenir , @pradeepachar-mavenir , May you take a look and approve in order to merge?
Thanks

@hdamker
Copy link
Contributor

hdamker commented Sep 13, 2024

@stroncoso-quobis thanks for asking, but I'm not part of the team here and don't have the bandwidth to review. Please proceed without my review.

Copy link
Collaborator

@pradeepachar-mavenir pradeepachar-mavenir left a comment

Choose a reason for hiding this comment

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

The changes are fine.

@stroncoso-quobis stroncoso-quobis merged commit 46ad6a4 into camaraproject:main Sep 24, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants