poor or missing documentation

Fermain / -mollify

9 stars 9 forks source link

poor or missing documentation #144

Closed StianSto closed 9 months ago

StianSto commented 11 months ago

some of the packages have poor or missing documentation. this leads newcomers to spend hours trying and failing while figuring out how each package works. these are the ones i found with missing documentation and instructions:

[x] molly
[ ] flow
[x] lms

MegumiKim commented 11 months ago

Also, documentation in the project's root folder needs to be updated.

ShaindalDev commented 11 months ago

@Fermain Is there written docs for the project?

Anclagen commented 11 months ago

I'm just making some updates to the read me, and added some more scripts to the package json in the main repo to make things easier PR here. I can also add a little content in the LMS readme about content creation for testing, if you want some test content as an example to look at I have some here in my fork

Fermain commented 11 months ago

@Fermain Is there written docs for the project?

Negativo

Anclagen commented 10 months ago

PR #150 has been merged this updates;

Main README updated for developers with instructions for install, setup, usage and content creation.
LMS README updated with a draft of a possible workflow for installing as an npm package, this is not currently functional.
Some minor updates to tts, molly and cli README files but these need further fleshing out

We (@MegumiKim) have also started testing out and organsing the docs package but this can start to really be fleshed out once packages are ready for installation through npm.

pretzL commented 9 months ago

@StianSto is this issue resolved with #150 or is there something left to do?

StianSto commented 9 months ago

yes, i am very happy with the new changes. great work!

im closing this issue, since it is kind of a large one. If I (or anyone else) find a specific issue related to documentation, its better to add specific documentation issues to the board, instead of keeping this one open :) thanks for the reminder 😅

i see flow still has a boilerplate readme, but then again it isnt finished yet i believe

MegumiKim commented 9 months ago

As Alex mentioned above, we started a doc packages in relation to this issue and I added some contents in it. But since it is not needed yet, I put it aside. I will create an issue so that someone can take it over when the time comes...