space-wizards / space-wizards/docs
Toolshed needs better documentation for beginners
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 42
- Forks
- 304
- PR merge metrics
- No merged PRs in 30d
Description
"Toolshed is one of the three primary built-in debug tools (alongside scsi and View Variables.) for RobustToolbox, functioning as the game’s development console. To use Toolshed, open the debug console or use the debug console in devwindow."
- How do I open the debug console? (check keybindings: Options>Control>Scroll down to Development>Open Console)
- How do I access devwindow? (write /devwindow in the chat)
- What is scsi and where is it's documentation?
Some Toolshed commands require that you have certain admin permissions, for example debug or mapping flags. These restricted commands are listed in clientCommandPerms.yml.
- How do I gain access to these restricted commands?
Turns out you need to give yourself these flags through the admin permissions window: F7 to open Admin Menu, open the permissions panel, then Add Admin, then enter your username (eg. localhost@JoeGenero) and click on all the '+' symbols to give all those flags.
All of this should be properly documented to save time for new contributors.
toolshed/environments.md says this:
"Cache your environments, ToolshedEnvironment is extremely expensive to create and should not be created more than once per system using them if possible.
Avoid using the default environment for non-debug things, construct your own environment for your systems."
- How do you cache your environment?
- How do you construct your own environment? Does this mean editing clientCommandPerms.yml? What is this even talking about?
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 with toolshed/environments.md and clientCommandPerms.yml, then verify the documented ways to open the debug console, access devwindow, and grant admin permissions. Check how scsi is documented and clarify environment caching and construction. Done means beginner-focused documentation answers each listed question without ambiguity.
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
- 45/100