diff options
Diffstat (limited to 'doc/development/documentation')
| -rw-r--r-- | doc/development/documentation/structure.md | 2 | ||||
| -rw-r--r-- | doc/development/documentation/styleguide.md | 16 |
2 files changed, 7 insertions, 11 deletions
diff --git a/doc/development/documentation/structure.md b/doc/development/documentation/structure.md index 1bb3dd3521b..e7a43f769b3 100644 --- a/doc/development/documentation/structure.md +++ b/doc/development/documentation/structure.md @@ -99,7 +99,7 @@ Larger instruction sets may have subsections covering specific phases of the pro Where appropriate, provide examples of code or configuration files to better clarify intended usage. - Write a step-by-step guide, with no gaps between the steps. -- Include example code or configurations as part of the relevant step. Use appropriate markdown to [wrap code blocks with syntax highlighting](../../user/markdown.html#colored-code-and-syntax-highlighting). +- Include example code or configurations as part of the relevant step. Use appropriate markdown to [wrap code blocks with syntax highlighting](../../user/markdown.md#colored-code-and-syntax-highlighting). - Start with an h2 (`##`), break complex steps into small steps using subheadings h3 > h4 > h5 > h6. _Never skip a hierarchy level, such as h2 > h4_, as it will break the TOC and may affect the breadcrumbs. diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 67b1f7eb1f1..9381082af85 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -642,19 +642,15 @@ do not use this option until further notice. Don't: - ```md - [merge requests](../../merge_requests/) - [issues](../../issues/tags.html) - [issue tags](../../issues/tags.html#stages) - ``` + - `../../merge_requests/` + - `../../issues/tags.html` + - `../../issues/tags.html#stages` Do: - ```md - [merge requests](../../merge_requests/index.md) - [issues](../../issues/tags.md) - [issue tags](../../issues/tags.md#stages) - ``` + - `../../merge_requests/index.md` + - `../../issues/tags.md` + - `../../issues/tags.md#stages` - Using the Markdown extension is necessary for the [`/help`](index.md#gitlab-help) section of GitLab. |