v2ray/manual

在开发者文档中增加示例或推荐默认值

Open

#252 opened on Feb 23, 2019

View on GitHub
 (1 comment) (2 reactions) (0 assignees)HTML (425 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (868 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

协议部分文档如VMess似乎有点过于简洁，建议适当可以加入一点BestPractice防止开发者误用。许多内容需要二次阅读源码，这对非Golang开发者不是太友好。

一点拙见

Contributor guide

Research direction
Review the existing VMess documentation page, identify areas lacking examples or default values, and add practical examples and best practices derived from the source code or community knowledge.
Tech stack
html
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80