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

Documentation and Developer Guidelines #9

Open
3 tasks
DinneK opened this issue Feb 28, 2025 · 0 comments
Open
3 tasks

Documentation and Developer Guidelines #9

DinneK opened this issue Feb 28, 2025 · 0 comments

Comments

@DinneK
Copy link

DinneK commented Feb 28, 2025

User Story:

  • As a developer, I want comprehensive documentation for API integrations and the comparison module so that I can maintain and extend the project easily.

Acceptance Criteria:

  • A detailed README includes setup instructions, an overview of the API’s JSON structure (including the nested "series" arrays), and usage examples.
  • Inline code comments and external documentation explain key functions and the dynamic data handling.
  • Documentation is updated to reflect any changes in the API integration.
@DinneK DinneK moved this to Todo in UN SDG Form Site Feb 28, 2025
@sgoggins sgoggins transferred this issue from chaoss/augur Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
UN SDG Form Site
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@DinneK