PathOfBuildingCommunity / PathOfBuildingCommunity/PathOfBuilding
Help Section Improvements
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Lua
- Sterne
- 5.4k
- Forks
- 2.4k
- Ø Merge
- 1 T. 12 Std.
- Gemergte PRs (30 T.)
- 26
Beschreibung
There are a number of improvements needed for the help section to be properly useful, PRs do not need to cover all sections and it is recommended you focus on only 1 or a few points at a time
help section can currently be accessed on the "about" popup (bottom left corner of the UI)
missing content:
- FAQ
- items tab
- - trader tool
- config tab
- - boss/enemy config
- - custom mods
- calcs tab
- skills tab
- other notable things
- - glossary of terms (from #2681)
other improvements wanted: (though these likely will not be merged until more content is added)
- make it easier to access/see (hotkey and/or button on main UI)
- add ability to colour lines or headers in the help section
- add ability to embed clickable links into help section (eg https://github.com/PathOfBuildingCommunity/PathOfBuilding/wiki/Keyboard-&-Mouse-Shortcuts )
- add markup version (.md) to webpage (https://pathofbuilding.community/)
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Help-Bereich, der über das About-Popup unten links in der UI aufgerufen wird, und wähle einen nicht abgehakten Inhalts- oder Präsentationspunkt aus, anstatt die gesamte Liste in Angriff zu nehmen. Als erledigt gilt die Aufgabe, wenn der ausgewählte Help-Inhalt oder die Verbesserung implementiert wurde und im Help-Bereich überprüft werden kann; der Punkt zur Markdown-Webseite sollte separat auf https://pathofbuilding.community/ abgehakt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua, markdown
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100