Write a man page for end users
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 38.2k
- Forks
- 4.6k
- Avg merge
- 19d 15h
- Merged PRs (30d)
- 1
Description
Currently the official documentation is ambiguous for novice users who only want to use the command line client to connect to their VPN servers and don't care about the technical aspects of json files or whatnot.
I suggest the creation of a manpage consisting a simple tutorial for configuring and connecting to proxy servers using the terminal. It should have explanations for importing config links and usage of Sing-Box subcommands and flags.
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
Review the existing official documentation and the command-line client's help output first. Define a man-page tutorial for configuring and connecting to proxy or VPN servers, importing config links, and using Sing-Box subcommands and flags. Done means novice users can follow the terminal steps without needing the technical JSON details.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100