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

[PM] PM Should Have Documentation #18

Open
andrewdimmer opened this issue Mar 2, 2021 · 0 comments
Open

[PM] PM Should Have Documentation #18

andrewdimmer opened this issue Mar 2, 2021 · 0 comments
Labels
API For work on the API documentation Improvements or additions to documentation Prize Module (PM) For all work pertaining to the Prize Module (PM) unallocated Currently not allocated to someone to work on Web App For work on the main web app

Comments

@andrewdimmer
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Currently, all knowledge of how the PM works is just based on reading the source code. This is convoluted and bad.

Describe the solution you'd like
Ideally, all PM functions, endpoints, and UI components should have proper method documentation. They should also have proper Markdown documentation files describing their purpose, use case, and design. It might also be worth adding documentation regarding data types and accepted values for the API, similar to what you might see in a Swagger API document.
@andrewdimmer andrewdimmer added documentation Improvements or additions to documentation API For work on the API Web App For work on the main web app Prize Module (PM) For all work pertaining to the Prize Module (PM) labels Mar 2, 2021
@andrewdimmer andrewdimmer changed the title PM: PM Should Have Documentation [PM] PM Should Have Documentation Mar 2, 2021
@andrewdimmer andrewdimmer added the unallocated Currently not allocated to someone to work on label Mar 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
API For work on the API documentation Improvements or additions to documentation Prize Module (PM) For all work pertaining to the Prize Module (PM) unallocated Currently not allocated to someone to work on Web App For work on the main web app
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@andrewdimmer