Release 1.0 Documentation

[kels271828]

Things we need to work on:

1. Comment on the structure before we start filling in content.
2. Main index.rst page needs a description
3. Section index.rst pages need descriptions
4. Individual pages need content added (or relevant docstrings updated)

One idea is that we can branch off of feature/docs to fill in content, then create PR's to feature/docs. Once we are happy with the documentation, we can merge this PR. People can comment on this PR with what sections and/or pages they want to write.

[kels271828]

We can also define some style conventions (e.g., Do we use Onemod, OneMod, etc. when referring to the package? What types of headings do we use?). This can be defined by whoever works on the developer guide contributing docs page.

[zhengp0]

Hahahaha

[kels271828]

Lol, I found the logo here (https://healthicons.org/), was hoping for something more relevant but ended up with this bkah!

[zhengp0]

Thanks very much @kels271828!

[blsmxiu47]

We can also define some style conventions (e.g., Do we use Onemod, OneMod, etc. when referring to the package? What types of headings do we use?). This can be defined by whoever works on the developer guide contributing docs page.

I like the idea of having style conventions. We could store them in the Contributing to Docs section of the Developer Guide. Personally I don't have strong style preferences though. Whatever is fine, as long as we are consistent.

[blsmxiu47]

To start I can work on the Developer Guide section (but anyone should feel free to propose style conventions), probably some parts of Advanced Usage, like DataInterface and Validation (if validation is a feature we intend to build out), and then will see what others haven't claimed.