agaric/documentation
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update documentation documentation formatting

Browse source
This commit is contained in:
benjamin melançon 2020-08-07 23:52:23 -04:00
parent 395ea0ec58
commit 04de273003
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
documentation.md
View file

@ -4,12 +4,12 @@ Welcome to the meta section of our documentation where we document how to do doc
Edit or add. That's the primary instruction. You can edit directly on [gitlab.com/agaric/documentation](https://gitlab.com/agaric/documentation) (for example, the edit link on this page takes you to [gitlab.com/agaric/documentation/blob/master/documentation.md](https://gitlab.com/agaric/documentation/blob/master/documentation.md)). 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. Edit or add. That's the primary instruction. You can edit directly on [gitlab.com/agaric/documentation](https://gitlab.com/agaric/documentation) (for example, the edit link on this page takes you to [gitlab.com/agaric/documentation/blob/master/documentation.md](https://gitlab.com/agaric/documentation/blob/master/documentation.md)). 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} ```{tip}
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. This documentation page is a good one to copy or refer to for an example of MyST formatting. And of course anyone can come and clean up formatting later.
``` ```
Where to post what ## Where to post what
------------------
We like [Gitlab's approach](https://about.gitlab.com/handbook/git-page-update/#where-should-content-go): If you're not sure where to put something in documentation, or if it even is documentation, [write a blog post](https://agaric.com/node/add/blog). Or even, in the Agaric context, just throw it in a [raw note](https://gitlab.com/agaric/resources/raw-notes) (this private repository automatically publishes non-draft notes publicly to [agaric.gitlab.io/raw-notes](https://agaric.gitlab.io/raw-notes/)). We like [Gitlab's approach](https://about.gitlab.com/handbook/git-page-update/#where-should-content-go): If you're not sure where to put something in documentation, or if it even is documentation, [write a blog post](https://agaric.com/node/add/blog). Or even, in the Agaric context, just throw it in a [raw note](https://gitlab.com/agaric/resources/raw-notes) (this private repository automatically publishes non-draft notes publicly to [agaric.gitlab.io/raw-notes](https://agaric.gitlab.io/raw-notes/)).
@ -17,8 +17,7 @@ Somewhere is better than nowhere.
Don't worry about [translation](translation). Don't worry about [translation](translation).
Guidelines ## Guidelines
++++++++++
* Document closest to where people work: * Document closest to where people work:
* In README.md files or otherwise in the code repository for developers. * In README.md files or otherwise in the code repository for developers.
@ -29,6 +28,7 @@ Guidelines
In doing documentation we are living our [values](values) of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships. In doing documentation we are living our [values](values) of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships.
``` ```
## Local preview
Running this documentation locally: Running this documentation locally: