search

OpenEugene / little-help-book-web

Human service resource guide powered by White Bird Clinic
MIT License
6 stars 4 forks source link

Create a docs folder #150

Open ArthurSmid opened 3 years ago

ArthurSmid commented 3 years ago

A docs folder would contain it's own readme.md as a table of contents and then another set of .md files as documents. Here's an example: https://github.com/MVPStudio/k8

So far our README has been a something of a folder for all new how-tos and tips about the site, though apparently that's not the actually intended purpose of a README, it's more for getting started as a contributor: https://mozilla.github.io/open-leadership-training-series/articles/opening-your-project/write-a-great-project-readme/

And then we'd have the docs folder with all the guides and how-tos for people who use the Little Help Book.

ArthurSmid commented 3 years ago

This outline for READMEs is interesting: https://blog.publiccode.net/news/2020/12/09/how-to-start-a-standard-compliant-repository.html

From the Foundation for Public Code

Together, we’re growing an ecosystem of open public-purpose software and policy.

ArthurSmid commented 3 years ago

This is in the above standard listed as a should and not a must, but given the question Dominic asked about dal, it could be more intuitive in the code to understand "data-access" or "data"?

"Make sure none of the documents include acronyms, abbreviations, puns or legal/domain specific terms in the codebase without an explanation preceding it or a link to an explanation."

There are probably words we can use that would be easier to understand in the codebase than nbc and dal?