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

Write documentation in Wiki and README #2

Open
vigliensoni opened this issue May 7, 2019 · 1 comment
Open

Write documentation in Wiki and README #2

vigliensoni opened this issue May 7, 2019 · 1 comment
Assignees
@DavidGarfinkle
Labels
HIGH PRIORITY required
Milestone
Release beta 0.0.1

Comments

@vigliensoni
Copy link
Member

vigliensoni commented May 7, 2019 •
edited
Loading

Write Wiki with one page per container, as well as a page for the general overview of the app. Write thorough information about the API endpoints in order to facilitate communication with the app.

Also, add a page for end users, with screenshots and direct URLs to easily see the results of a given set of queries.
@vigliensoni vigliensoni added this to the Release beta 0.0.1 milestone Sep 4, 2019
@vigliensoni
Copy link
Member Author

The user should really understand how the searching is implemented, otherwise some results do not make any sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DavidGarfinkle DavidGarfinkle

Labels
HIGH PRIORITY required
Projects
None yet
Milestone
Release beta 0.0.1
Development

No branches or pull requests
2 participants
@vigliensoni @DavidGarfinkle