midspace / midspace/Space-Engineers-Admin-script-mod
Improve the help text
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 43
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
Need to conceive and implement a useful two level help system,
Currently the /help provides simple chat screen text.
Add a a new command for a dialog help, which has a full description and working examples.
/helpmore ?
/help2 ?
The original help should be cut down where appropriate to a simple detailed description of the input parameters and the output. No examples.
/help by itself should show as a dialog.
Contributor guide
No contributing guide indexed for this repository
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 current /help command handler and its chat-screen output. Define the two help levels from the issue: /help should open a concise dialog with parameters and output, while a new command should provide descriptions and examples; verify both commands and dialog behavior in the game.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100