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

Possible Documentation Website #33

Open
enpuyou opened this issue Feb 25, 2021 · 0 comments · May be fixed by #89
Open

Possible Documentation Website #33

enpuyou opened this issue Feb 25, 2021 · 0 comments · May be fixed by #89
Assignees
@enpuyou @zaethovenn @Peter-Snipes @kailaniwoodard
Labels
documentation Improvements or additions to documentation enhancement New feature or request Team 6 [Kai'lani Woodard, Peter Snipes, Zackery Devers, Abigail Waryanka]

Comments

@enpuyou
Copy link
Contributor

enpuyou commented Feb 25, 2021 •
edited
Loading

Context and feature:
GatorMiner is a visualized, interactive text analysis tool. It has various types of analysis that are built-in and the current documentation in README.md is far from enough to explain the features and visualizations. One interesting solution might be developing a website solely for documentation purposes.

Proposed solution:
Material for MkDocs provides a simple and aesthetic theme for documentation websites. It can be easily installed through Python and allows for tons of customizations.

Additional context:
Possible website deployment on Netlify
@enpuyou enpuyou self-assigned this Feb 25, 2021
@enpuyou enpuyou added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 25, 2021
@enpuyou enpuyou mentioned this issue Mar 24, 2021
Open
@kailaniwoodard kailaniwoodard added the Team 6 [Kai'lani Woodard, Peter Snipes, Zackery Devers, Abigail Waryanka] label Apr 7, 2021
@enpuyou enpuyou linked a pull request Apr 22, 2021 that will close this issue
Open
8 tasks
@enpuyou enpuyou reopened this May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@enpuyou enpuyou

@zaethovenn zaethovenn

@Peter-Snipes Peter-Snipes

@kailaniwoodard kailaniwoodard

Labels
documentation Improvements or additions to documentation enhancement New feature or request Team 6 [Kai'lani Woodard, Peter Snipes, Zackery Devers, Abigail Waryanka]
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue#33 ~ Documentation Website GatorEducator/GatorMiner
4 participants
@enpuyou @zaethovenn @Peter-Snipes @kailaniwoodard