Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-08-19 03:38:08 -04:00
Code Issues Projects Releases Packages Wiki Activity

Update doc style guide and instructions

Browse source 
- Explain why image linking is important
- Improve wording
- Fix link
- Minor improvements
This commit is contained in:
Andrew David Wong 2021-07-10 12:52:48 -07:00
parent ce900bfea7
commit f608865417
No known key found for this signature in database
GPG key ID: 8CE137352A019A17
2 changed files with 20 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

8
developer/general/how-to-edit-the-documentation.md
View file

@ -126,7 +126,7 @@ pull request, we'll post a comment explaining why we can't.
The source file for the [documentation index (a.k.a. table of contents)](/doc/)
is
[_data/doc-index.yml](https://github.com/QubesOS/qubesos.github.io/blob/master/_data/doc-index.yml).
[doc-index.yml](https://github.com/QubesOS/qubesos.github.io/blob/master/_data/doc-index.yml).
Editing this file will change what appears on the documentation index. If your
pull request (PR) adds, removes, or edits anything that should be reflected in
@ -135,9 +135,9 @@ request against this file.
## How to add images
To add an image to a page, use the following syntax in the main document. This
will make the image a hyperlink to the image file, allowing the reader to click
on the image in order to view the image by itself.
To add an image to a page, use the following syntax in the main document (see
[here](/doc/documentation-style-guide/#image-linking) for why this syntax is
important).
```
[![Image Title](/attachment/doc/image.png)](/attachment/doc/image.png)