Document the cli subcommand
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 327
- Forks
- 653
- PR merge metrics
- No merged PRs in 30d
Description
Include required information
Hi guys,
First off goes my thanks to dev and particularly for documentation you make - not all devs get(for some inexplicable reason) how crucial man pages are to the all the rest of us(whole-world - devs =)
I run my Syncthing on Centos and I'm not sure if it's just distro's package issues but in case it's not - then please do with the 'cli' subcommand what you have done with the rest of 'Syncthing': Give it a nice juicy man page!!!
Please be sure to include at least:
- what problem your new feature would solve
- how or why you think it is generally useful (i.e., not just for you)
- what alternatives or workarounds you considered
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 reading the existing Syncthing man-page documentation and the cli subcommand reference to identify the structure and required content. Document the cli subcommand in a matching man page, including its purpose, usage, and options, and verify that the result is consistent with the other Syncthing documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100