help.yml file needs documentation on wiki

Open
#162 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
cli

Research direction

Review help.yml and config.yml first to understand the current help messages and configuration structure. Clarify whether the intended scope is wiki documentation, a permission-aware /help component, a commandbook.help. node, pagination settings, or some combination. Done means the agreed scope is documented and its behavior is verified.

Written by the indexing model from the issue text.

Description

CMDBOOK-2162 - Reported by z00100100

i was thinking if either one you could add a wiki for the help.yml and add a help componant that checks the permission nodes of the group the person is in to give them a /help. and add a setting in the config.yml like help: lines-per-page:

and if you dont want to add the check for permissions then maybe add a node like commandbook.help. but still add the lines per page of help this into the config.yml. there is no good help plugin out there but i like yours since i can make my own custom messages with it as well.

Dominant language
Java
Stars
151
Forks
104
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EngineHub/CommandBook

All issues in EngineHub/CommandBook

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.