diff options
| author | Alex <alex@adnab.me> | 2021-03-18 10:39:55 +0100 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2021-03-18 10:39:55 +0100 |
| commit | 5b659b28ce6bef15072d2fc93f777aa8ff73b2d8 (patch) | |
| tree | e7ec9ec9dae459aeb6a99b35c537d46745053ec0 /doc/book/src/working_documents/index.md | |
| parent | 6a3dcf39740cda27e61b93582b6fea66991ec4f2 (diff) | |
| parent | ea21c544343afeb37e96678089bcd535e64982a7 (diff) | |
| download | garage-5b659b28ce6bef15072d2fc93f777aa8ff73b2d8.tar.gz garage-5b659b28ce6bef15072d2fc93f777aa8ff73b2d8.zip | |
Merge pull request 'Add a `mdbook` documentation to present garage and help user on-boarding' (#45) from feature/mdbook into master
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/45
Diffstat (limited to 'doc/book/src/working_documents/index.md')
| -rw-r--r-- | doc/book/src/working_documents/index.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/book/src/working_documents/index.md b/doc/book/src/working_documents/index.md new file mode 100644 index 00000000..a9e7f899 --- /dev/null +++ b/doc/book/src/working_documents/index.md @@ -0,0 +1,8 @@ +# Working Documents + +Working documents are documents that reflect the fact that Garage is a software that evolves quickly. +They are a way to communicate our ideas, our changes, and so on before or while we are implementing them in Garage. +If you like to live on the edge, it could also serve as a documentation of our next features to be released. + +Ideally, once the feature/patch has been merged, the working document should serve as a source to +update the rest of the documentation and then be removed. |