PathOfBuildingCommunity / PathOfBuildingCommunity/PathOfBuilding
Help Section Improvements
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 5.4k
- Forks
- 2.4k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 26
Description
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/)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the Help section accessed through the About popup in the bottom-left of the UI, and choose one unchecked content or presentation item rather than attempting the whole list. Done means the selected help content or improvement is implemented and can be verified in the Help section; the markdown webpage item should be checked separately on https://pathofbuilding.community/.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100