SagerNet / SagerNet/sing-box

Minor documentation improvements

Open
#4,500 0 comments 0 reactions 0 assignees View on GitHub

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:
docs/configuration/experimental/cache-file.md:
  • Mark "store_rdrc" and "rdrc_timeout" as Deprecated in Structure section
docs/configuration/route/rule.md:
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/0 etc. paths does not work
docs/configuration/rule-set/headless-rule.md:
docs/configuration/outbound/direct.md:
docs/configuration/outbound/tuic.md:
  • Structure section has "zero_rtt_handshake" and "heartbeat" fields, but there are no descriptions for them
docs/configuration/inbound/shadowsocks.md:
  • Structure section has "users" and "destinations" fields, but there are no descriptions for them
docs/configuration/inbound/naive.md:
  • Structure section missing JSON indentation
docs/configuration/inbound/tun.md:
  • Structure section missing "netns"
docs/configuration/endpoint/wireguard.md:
  • Structure section has "listen_port" field, but there are no description for it
docs/configuration/endpoint/tailscale.md:
  • Mark "ssh_server" in Structure section as "ssh_server": false, // or {}
docs/configuration/dns/index.md:
  • Mark "fakeip" and "independent_cache" as Deprecated in Structure section
docs/configuration/dns/rule.md:
docs/configuration/dns/dhcp.md:
  • Typo in "Tge" -> "The"

Contributor guide

No contributing guide indexed for this repository

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

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.