g3 icon indicating copy to clipboard operation
g3 copied to clipboard

Published 20 hours ago • verified publisher icon bytedance

Documentation Improvements

Open mspublic opened this issue 4 months ago • 3 comments

G3 is a great project! The documentation on how to fully setup everything end to end unfortunately is a bit lacking.

I am creating this issue to track improvements in documentation.

I will definitely help on the English side/work with the team to translate as best as possible/submit PRs for them. Also I would like to help submit new example configs as well.

@zh-jq - would you like me to create new issues for all areas that are needing documentation or should we keep that just under this main issue?

Example:

  1. How would I use g3proxy to do forward proxying with SSL inspection? (Needing to use g3fcgen etc).

  2. How do I configure a “frontend” with g3fcgen?

These as just examples. @zh-jq if it’s easier to quickly right your docs in Chinese I can use tools to translate - but will need to have you review for accuracy.

Thanks again for all your work!!

mspublic avatar Feb 16 '24 17:02 mspublic