Skip to content

Possible Documentation Website #33

@enpuyou

Description

@enpuyou

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

Metadata

Metadata

Labels

Team 6[Kai'lani Woodard, Peter Snipes, Zackery Devers, Abigail Waryanka]documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions