Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a docs folder #150

Open
ArthurSmid opened this issue Dec 9, 2020 · 2 comments
Open

Create a docs folder #150

ArthurSmid opened this issue Dec 9, 2020 · 2 comments

Comments

@ArthurSmid
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant