PathOfBuildingCommunity/PathOfBuilding

Help Section Improvements

Open

#6093 opened on Apr 20, 2023

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

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

Tech stack
None
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Path of BuildingBasic scripting knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the help section implementation in the UI code. The issue mentions the 'about' popup; find the relevant file (likely in the 'ui' or 'modules' directory). Add content to the help section by following existing examples. For clickable links, investigate how the UI renders text. Refer to issue #2681 for glossary terms.