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.

Sign up for GitHub

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

Jump to bottom

Where documentation goes matters #1

Open
openprivacy opened this issue Sep 24, 2018 · 0 comments
Open

Where documentation goes matters #1

openprivacy opened this issue Sep 24, 2018 · 0 comments

Comments

@openprivacy
Copy link
Member

  • A link to sandbox.md ought to be in the top-level project/code/README.md
  • Module documentation would be in the module's README.md
  • And ops documentation in the project/ops/README.md or ops/wiki

Where project owners, proposal and contract info and security/compliance docs go should go is an open question. Maybe in the project/documentation repos as has been created for GlobalNET.

The overarching goal is to have the documentation close at hand to developer and operations teams as code and scripts change rapidly, and the documentation should change just as rapidly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@openprivacy