vanitasvitae/openpgp-notes
1
0
Fork 0
mirror of https://codeberg.org/openpgp/notes.git synced 2025-09-09 11:19:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

typo fixes

Browse source
This commit is contained in:
Heiko Schaefer 2023-12-12 21:29:10 +01:00
parent da1afafda5
commit a8a902ea45
No known key found for this signature in database
GPG key ID: DAE9A9050FCCF1EB
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -5,7 +5,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0
# Contributing
These are the contribution guidelines for "Notes on OpenPGP".
These are the contribution guidelines for "Notes on OpenPGP."
Development takes place at https://codeberg.org/openpgp/notes.
@ -84,7 +84,7 @@ There are a few guidelines when it comes to cross-referencing, which work around
* When adding [explicit targets], use [kebab case].
* Do not rename already released [explicit targets], as it will break deep linking by downstreams relying on these targets.
* When referencing chapters by file, use `[](/my-chapter)`, instead of relying on [explicit targets] for a top-level heading.
* To reference a figure by its title, use `[](#my-figure)` for a figure with the `:name:` attribute `my-figure` (and e.g. the title `My Figure`).
* To reference a figure by its title, use `[](#my-figure)` for a figure with the `:name:` attribute `my-figure` (and e.g., the title `My Figure`).
* To reference a figure by number (e.g. `Fig. 1`), use ```{numref}`my-figure` ``` for a figure with the `:name:` attribute `my-figure`.
#### Figures
@ -95,7 +95,7 @@ The `:alt:` attribute should explain what is displayed in the picture, as this i
#### Glossary
This project defines terms in a [glossary]. Using the `term` role, it is possible to reference these terms from anywhere.
Given a term `My Term` in the glossary, it is possible to refernce it directly using ```{term}`my term```` or indirectly ```{term}`something else<My Term>````.
Given a term `My Term` in the glossary, it is possible to reference it directly using ```{term}`my term```` or indirectly ```{term}`something else<My Term>````.
There are a few rules, that should be kept in mind when creating terms and referencing them.