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

Strategy for consolidation of hyperlinks to central documentation

Aperta
  • Qualcosa non va?
#93 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
github-actions, markdown
Ambito
ci-cd, documentation

Direzione di ricerca

Esamina innanzitutto #86, gli aggiornamenti completati del README nei repository principali elencati e gli elementi rimanenti della checklist. Definisci la pagina della strategia di documentazione, l’ambito della pulizia standard dei link e i controlli degli URL di GitHub Actions nei repository indicati. Il lavoro è considerato completato quando la strategia concordata è documentata, i sottolink ridondanti sono stati gestiti e i controlli richiesti sono configurati o suddivisi in issue distinte.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Following/as part of close out of https://github.com/BHoM/documentation/pull/92 and the restructuring of documentation navigation...
A suggested strategy for consolidation of hyperlinks

We have a large number of references to various sub-pages of the BHoM docs across READMEs and other locations from outside of the BHoM documentation itself.
Suggesting a series of possible actions to consolidate curated links to small number of core repos and locations.
With the wider repos and standard templates being simplified to just point to high level https://bhom.xyz/documentation/ (as the search now is pretty good!)

Then suggesting we set up GitHub actions specifically on these small numbers of repos to potentially support the checking validity of URLs.
This can be in support of wider review of documentation strategy for our code being looked at by @travispotterBH, @michaelhoehn and others too.

We should also create a Documentation page outlining our documentation strategy. (We already have a nice page on editing, but one to outline the structure and approach will be good 🐶🥫 😄)

So a proposed list of actions for closing out or raising as discrete issues as appropriate are below:

@alelom, @FraserGreenroyd fyi

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.