Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alelom opened this issue Nov 24, 2023 · 2 comments
Assignees
Labels
type:feature New capability or enhancement

Comments

@alelom
Copy link
Member

alelom commented Nov 24, 2023

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: #83 (comment).

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 for a strategy to identify all links to be uniformed.

@alelom alelom added the type:feature New capability or enhancement label Nov 24, 2023
@alelom alelom self-assigned this Nov 24, 2023
@al-fisher
Copy link
Member

Think-your-dashes-convention-works-well.

@alelom
Copy link
Member Author

alelom commented Nov 25, 2023

We_dont_fancy_snake_case_anyways!

@alelom alelom changed the title Uniform .md file names and links to allow link checker to work without false flags Uniform links and .md file names to allow link checker to work without false flags Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature New capability or enhancement
Projects
None yet
Development

No branches or pull requests

2 participants