search

Fermain / -mollify

9 stars 9 forks source link

Start creating a preliminary documentation set for the project #151

Closed ShaindalDev closed 10 months ago

ShaindalDev commented 11 months ago

Documentation set for the project. Some is written allready and PR for it can be found here. This issue is a task that will continue past sprint 1 since the documentation will continue to grow until it's finished.

Anclagen commented 11 months ago

I assume this task should encompass issue #144 as well with are primary goals being to update all the package read me files. I think the main repo read me should direct developer working with the project and the individual package read me files should be geared towards and npm style read me guide.

I'm also wondering if we should setup the docs package to run through the LMS to provide documentation or set it up to run as a separate entity similar to the lms, I'm sure we can find a package to create a standard docs layout then fill up the content with more specific information on using various packages as they are built.