NeonGeckoCom / NeonGeckoCom/neon-docs

[FEAT] Document `mana` commands for troubleshooting

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

Nobody has claimed this yet.

documentation enhancement help wanted
Dominant language
No language data
Stars
5
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Objective

Document the mana CLI util.

Initial Implementation Requirements
  • Implement some automation to push the mana readme file into a configured doc page
  • Add some note or link in the troubleshooting section to how mana can be used when STT isn't working
Other Considerations

Noted on Matrix

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.

Research direction

Start with the linked mana README and the repository's troubleshooting section. Determine how a configured documentation page is maintained, then document the relevant mana commands for STT troubleshooting and define how the README is pushed there. Done means the configured page contains the README material and troubleshooting includes a mana reference.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.