Skip to content

Include instructions on a few endpoints to demo #107

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

Open
mcollina opened this issue May 14, 2025 · 1 comment
Open

Include instructions on a few endpoints to demo #107

mcollina opened this issue May 14, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@mcollina
Copy link
Member

Currently the README does not include what this demo does, and what are the main endpoints to call.

A user stumbling here, would not know what to do to explore this.

@jean-michelet
Copy link
Member

jean-michelet commented May 14, 2025

I can add a short description explaining that this is a simple task management application and add a step explaining how to open the swagger documentation to see endpoints (easier than to maintain a reference table).

@jean-michelet jean-michelet added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 17, 2025
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants