PathOfBuildingCommunity / PathOfBuildingCommunity/PathOfBuilding-PoE2
add some how-to and troubleshooting on main page and github readme
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 1.9k
- Forks
- 451
- Avg merge
- 21h 16m
- Merged PRs (30d)
- 68
Description
Check for duplicates
- I've checked for duplicate open and closed issues by using the search function of the issue tracker
What platform are you running Path of Building on?
Windows
Is your feature request related to a problem?
The main readme page on github (and the main website) do not offer any basic how-to and troubleshooting instructions after installing.
Describe the solution you'd like
Please add a short how-to and troubleshooting guide on main page and readme on github. Especially for how to authenticate with POE2 account and when it doesn't work.
Describe alternatives you've considered
google and youtube have not helped.
Additional context
No response
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 by locating the GitHub README and the website's main page, then review the existing installation and authentication information. Add short how-to and troubleshooting guidance for POE2 account authentication, including when it fails; the work is done when both requested entry points provide this guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100