BHoM / BHoM/documentation

Uniform links and `.md` file names to allow link checker to work without false flags

Open
#86 2 comments 1 reaction 1 assignee Claimed by @alelom View on GitHub
type:feature
Dominant language
C#
Stars
88
Forks
18
Avg merge
6d 19h
Merged PRs (30d)
2

Description

As highlighted in the link strategy (#84), we can uniform our file names to enable the powerful link checker ability. This is required to avoid false flags, as for example happens here: https://github.com/BHoM/documentation/pull/83#issuecomment-1825686188.

In a nutshell:
1. Rename all `.md` files that have whitespaces in their name. Replace them with underscores or dashes (do we have a preference @al-fisher ? I think we've used dashes in some of them).
2. Replace all links to those files so they keep working in the exposed website and that the link checker doesn't detects them as false flags. This can be simply done by shift-dragging the file you want to link into the text.

See [this comment](https://github.com/BHoM/documentation/pull/92#discussion_r1409574515) for a strategy to identify all links to be uniformed.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.