diff --git a/documentation.rst b/documentation.rst new file mode 100644 index 0000000..4a5d0b2 --- /dev/null +++ b/documentation.rst @@ -0,0 +1,23 @@ +.. _documentation: + +Documentation +============= + +Welcome to the meta section of our documentation where we document how to do documentation! + +Edit or add. That's the primary instruction. You can edit directly on `gitlab.com/agaric/documentation ` (for example, the edit link on this page takes you to `gitlab.com/agaric/documentation/blob/master/documentation.rst `). If you aren't a member of Agaric, GitLab will helpfully offer to fork the documentation to your own namespace so that you can make a merge request with your documentation suggestion. + +.. note:: + This documentation page is a good one to copy or refer to as an example for ReStructuredText formatting. And of course + +anyone can come and clean up formatting later. + +Principles +---------- + +* Document closest to where people work: + * In README.md files or otherwise in the code repository for developers, . +* Abstract and link here + +.. note:: + In documentation we are living our `values <>` of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships.