Introduce distinct doc/ and notes/ directories
This commit is contained in:
committed by
=Michael Hohn
parent
781571044d
commit
6262197c8d
11
doc/README.md
Normal file
11
doc/README.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
## The doc/ directory
|
||||||
|
The `doc/` directory serves as home for documentation. This is the place to
|
||||||
|
put refined documentation after it has gone through `notes/`. The contents of
|
||||||
|
this directory should be accessible to a broad audience including prospective
|
||||||
|
users, active users, and developers. Highly technical
|
||||||
|
|
||||||
|
1. The note authors and
|
||||||
|
2. Developers of the project
|
||||||
|
|
||||||
|
It need not be meaningful to casual users.
|
||||||
|
|
||||||
9
notes/README.md
Normal file
9
notes/README.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
## The notes/ directory
|
||||||
|
The `notes/` directory serves as staging directory for documentation. This is
|
||||||
|
the place to develop documentation and short notes. The contents of this
|
||||||
|
directory should be accessible to
|
||||||
|
1. The note authors and
|
||||||
|
2. Developers of the project
|
||||||
|
|
||||||
|
It need not be meaningful to casual users.
|
||||||
|
|
||||||
Reference in New Issue
Block a user