From a8a902ea45e0f1adbc0cf63b6c1223179f07aab5 Mon Sep 17 00:00:00 2001 From: Heiko Schaefer Date: Tue, 12 Dec 2023 21:29:10 +0100 Subject: [PATCH] typo fixes --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3bc6334..d0e9f38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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````. +Given a term `My Term` in the glossary, it is possible to reference it directly using ```{term}`my term```` or indirectly ```{term}`something else````. There are a few rules, that should be kept in mind when creating terms and referencing them.