123ishaTest / 123ishaTest/igt-docs

Headline "Requirements" aren't requirements, but features

Aperta Adatta ai principianti
#2 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
5
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I was confused reading the docs where the subheadline of feature pages say "Requirements" but the list under it is a list of use cases, not requirements. Since `Feature` is already a class name in the tool (and so is `Requirements` for that matter), what about changing this headline to "Purpose" or "Benefits", "Advantages", "Properties", "Traits", etc. or something like that?

Example:

image

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Look at the documentation pages for features in the project, likely in the docs/ directory. Find where the 'Requirements' headline is used and change it to a more accurate term like 'Purpose' or 'Benefits'. Verify the change by checking the rendered documentation locally or in a preview.

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

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
85/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.