PathOfBuildingCommunity/PathOfBuilding

Help Section Improvements

Open

#6,093 opened on Apr 20, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Lua (2,318 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (5,224 stars)
PR merge metrics
 (Avg merge 8h 37m) (1 merged PR in 30d)

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)

Contributor guide

Research direction
Identify which help sections are missing content and implement them using the existing help system. Check the 'about' popup for current help structure.
Tech stack
lua
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60