Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#86 2 commenti 1 reazione 1 assegnatario Vedi su GitHub

@alelom ci sta già lavorando.

Dal 24/11/2023.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

type:feature

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

Lingua principale
C#
Stelle
88
Fork
18
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di BHoM/documentation

Tutte le issue di BHoM/documentation

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.