search

asam-ev / asam-project-guide

(WIP!) Project Guide for ASAM OpenX standards
Mozilla Public License 2.0
2 stars 0 forks source link

Content feedback: Broken link "Settings for Visual Studio Code" in ASAM Editorial Guide #127

Closed christiangoedert closed 2 years ago

christiangoedert commented 2 years ago

Prerequisites

This is in regards to:

Subject

Broken link "Settings for Visual Studio Code" in section "2.8. Delete trailing whitespace characters (ASM-20)" in the ASAM Editorial Guide

Section

2.8. Delete trailing whitespace characters (ASM-20)

Description

Suggestion

Fix the broken link to "Settings for Visual Studio Code".
URL https://asam-ev.github.io/asam-project-guide/asamprojectguide/latest/compendium/Editorial_guide.html
Page Editorial guide
Module compendium
philipwindecker commented 2 years ago

Note: The link points to the html instead of the adoc file. I strongly recommend to use the Antora syntax all the time, since otherwise broken links cannot be detected by the Antora pipeline automatically.

Currently implemented: https://asam-ev.github.io/asam-project-guide/asamprojectguide/latest/tooling/vscode/vscode-guides.html#_automatic_removal_of_spaces_after_periods[Settings for Visual Studio Code]

Improved: xref:compendium:Tools/vscode/vscode-guides.adoc#_automatic_removal_of_spaces_after_periods[Settings for Visual Studio Code]

(Note: This points to the tool's collection page, not the source file)

Best: xref:compendium:Guidelines/vscode-recommended_vscode_settings.adoc#_automatic_removal_of_spaces_after_periods[Settings for Visual Studio Code]

(Note: This points to the source file in the Compendium)

philipwindecker commented 2 years ago

Fixed with https://github.com/asam-ev/asam-project-guide-content/commit/0f1323cc9378cf367edd7258527b4267373b8cc5