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

Update README/ Improve API Documentation #47

Open
chukaibejih opened this issue May 8, 2023 · 2 comments
Open

Update README/ Improve API Documentation #47

chukaibejih opened this issue May 8, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@chukaibejih
Copy link
Owner

chukaibejih commented May 8, 2023

  • The README's API Endpoints section should be revised to reflect the current set of endpoints that are available in the project.
    https://github.com/chukaibejih/smart_learn#api-endpoints

  • Enhance the API documentation by providing more detailed explanations of endpoints, request/response examples, and authentication requirements. This will make it easier for developers to integrate the API into their projects.

@chukaibejih chukaibejih added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 8, 2023
@chukaibejih chukaibejih changed the title Update README Update README - API Endpoints May 8, 2023
@chukaibejih chukaibejih changed the title Update README - API Endpoints Update README/ Improve API Documentation Jul 3, 2023
@mayals
Copy link
Contributor

mayals commented Jul 9, 2023

Hello Chukwuka,

Could I add this step in .Getting Started, as detail step after or before the step number 5 ?

-- Go to .settings.DATABASES, then deactivate #PRODUCTION mode and activate #Development mode, add PostgreSQL configuration to connect to your database to be the default database.

@chukaibejih
Copy link
Owner Author

Hello May,

Yes, you can add that step in the "Getting Started" section. Thank you for suggesting this addition!

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