Minor documentation improvements
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 38.2k
- Forks
- 4.6k
- Avg merge
- 19d 15h
- Merged PRs (30d)
- 1
Description
There are some suggestions on improving (fixing errors) documentation:
docs/changelog.md:
"domain_label_count"and"search_domain_available"are referenced for1.14.0but does not actually exist anywhere:
https://github.com/SagerNet/sing-box/blob/b4b5af50b37dbdb3015e7a4b6b1c08a2dee80dbe/docs/changelog.md?plain=1#L337-L338
docs/configuration/experimental/cache-file.md:
- Mark
"store_rdrc"and"rdrc_timeout"as Deprecated inStructuresection
docs/configuration/route/rule.md:
"preferred_by"missing "openvpn" and "openconnect" outbounds (they both implementOutboundWithPreferredRoutes).
https://github.com/SagerNet/sing-box/blob/b4b5af50b37dbdb3015e7a4b6b1c08a2dee80dbe/protocol/openvpn/client.go#L36
https://github.com/SagerNet/sing-box/blob/b4b5af50b37dbdb3015e7a4b6b1c08a2dee80dbe/protocol/openconnect/client.go#L37
docs/configuration/rule-set/index.md:
- Add note about that on SFA (and possibly SFI)
"initial_path"path should be accessible to SFA (e.g. be in it's working directory) because Android restricts access to Internal Memory and/sdcard,/storage/emulated/0etc. paths does not work
docs/configuration/rule-set/headless-rule.md:
- Block "The default rule uses the following matching logic" misses
source_ip_cidrin logic description, but source code have appropriate logic
https://github.com/SagerNet/sing-box/blob/b4b5af50b37dbdb3015e7a4b6b1c08a2dee80dbe/route/rule/rule_headless.go#L84
docs/configuration/outbound/direct.md:
- Mark
"store_rdrc"and"rdrc_timeout"as Deprecated inStructuresection - Remove line "Protocol value can be 1 or 2.", as it refers to a undocumented feature removed in sing-box 1.6.0
https://github.com/SagerNet/sing-box/blob/b4b5af50b37dbdb3015e7a4b6b1c08a2dee80dbe/docs/configuration/outbound/direct.md?plain=1#L44
https://github.com/SagerNet/sing-box/blob/b4b5af50b37dbdb3015e7a4b6b1c08a2dee80dbe/protocol/direct/outbound.go#L81
docs/configuration/outbound/tuic.md:
Structuresection has"zero_rtt_handshake"and"heartbeat"fields, but there are no descriptions for them
docs/configuration/inbound/shadowsocks.md:
Structuresection has"users"and"destinations"fields, but there are no descriptions for them
docs/configuration/inbound/naive.md:
Structuresection missing JSON indentation
docs/configuration/inbound/tun.md:
Structuresection missing"netns"
docs/configuration/endpoint/wireguard.md:
Structuresection has"listen_port"field, but there are no description for it
docs/configuration/endpoint/tailscale.md:
- Mark
"ssh_server"inStructuresection as"ssh_server": false, // or {}
docs/configuration/dns/index.md:
- Mark
"fakeip"and"independent_cache"as Deprecated inStructuresection
docs/configuration/dns/rule.md:
"preferred_by"missing "openvpn" outbound? (possibly supported, NOT TESTED BY MYSELF).
https://github.com/SagerNet/sing-box/blob/b4b5af50b37dbdb3015e7a4b6b1c08a2dee80dbe/protocol/openvpn/dns_transport.go#L280
docs/configuration/dns/dhcp.md:
- Typo in "Tge" -> "The"
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 listed files under docs/, starting with the linked changelog, rule, and direct outbound sections and the corresponding source references. Update the specified labels, fields, descriptions, examples, and typo without changing unrelated content; done means each listed documentation discrepancy is addressed, including the Android path note and the uncertain OpenVPN item.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android, go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100