shadowsocks / shadowsocks/shadowsocks-org
Separate scope and responsibility of whitepaper and wiki pages
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1k
- Forks
- 694
- PR merge metrics
- No merged PRs in 30d
Description
It seems now we have an official whitepaper whose content is mostly mirrored from the wiki pages. May I suggest that we separate the responsibilities of the two to avoid the need to keep both in sync?
I propose the following split:
- Whitepaper for official protocol specification in RFC-style.
- Wiki pages for guides, tutorials, and other helpful content.
Additionally, we need to come up with a better strategy to generate the content of the official website. It's less than optimal right now due to case-sensitivity of file paths. (Maybe this needs another issue to discuss?)
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
Compare whitepaper/whitepaper.md with the referenced wiki pages to identify duplicated responsibilities. Review how the official website currently generates content and where case-sensitive file paths affect it. Done means an agreed separation between RFC-style protocol documentation and wiki guides, plus a documented website-generation strategy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, markdown
- Domain
- content, documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 20/100