You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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?
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.
The text was updated successfully, but these errors were encountered: