search

inhindsight / hindsight

Apache License 2.0
12 stars 8 forks source link

Many Apps do not have documentation #207

Closed ManApart closed 4 years ago

ManApart commented 4 years ago

Many apps have a 'todo' in their readme for documentation. This makes it harder for developers to grasp the context of an app without reading through all of it (and some of other apps') code.

We have a card for documenting modules and functions (#50), but even before we play that card we should have a top level description/document for the apps themselves.

jdenen commented 4 years ago

Closing as duplicate of #49

And that issue will be closed soon. My follow up to #188 is to document all our changes. Well, I'm documenting everything since I'm already there.