MLMI2-CSSI/foundry

Make gameplan for potential overhaul of Foundry docs

Closed this issue · 1 comments

As a User, I want intuitive, comprehensive documentation. Sometimes it can be hard to find things in the foundry docs, or info is repeated across portions

Look at other packages with really clean docs (Typer) and make a proposal of changes to the foundry docs to make them more navigable and intuitive. Some questions to ask are: do we want to move away from GitBook to something else? How do we want the docs to be structured? is information repeated? are the example code snippets easy to follow?

Assumptions:

Acceptance Criteria

Given..., when..., then...

documentation is getting a huge overhaul with refactor