Skip to content

docs(readme): add Full Tunnel mode section#677

Closed
yyoyoian-pixel wants to merge 1 commit intotherealaleph:mainfrom
yyoyoian-pixel:docs/full-tunnel-readme
Closed

docs(readme): add Full Tunnel mode section#677
yyoyoian-pixel wants to merge 1 commit intotherealaleph:mainfrom
yyoyoian-pixel:docs/full-tunnel-readme

Conversation

@yyoyoian-pixel
Copy link
Copy Markdown
Contributor

Summary

  • Add a dedicated Full Tunnel mode section to the main README, between "How it works" and "Quick Start"
  • Explains what Full Tunnel is, why you'd use it over apps_script mode (YouTube, UDP/Telegram, quota), the architecture, and what's needed to set it up
  • Links to CodeFull.gs and the tunnel-node README for step-by-step setup

Previously Full Tunnel was only mentioned in passing in two FAQ answers — easy to miss for new users.

Test plan

  • Verify rendered markdown on GitHub looks correct
  • Confirm links to CodeFull.gs and tunnel-node/README.md resolve

🤖 Generated with Claude Code

@github-actions github-actions Bot added the type: docs docs: PR — auto-applied by release-drafter label May 3, 2026
The main README had no mention of Full Tunnel mode beyond passing
references in the FAQ. Add a dedicated section between "How it works"
and "Quick Start" that explains what Full Tunnel is, why you'd use it
(YouTube, UDP, quota), the architecture diagram, and what you need to
set it up.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@yyoyoian-pixel yyoyoian-pixel force-pushed the docs/full-tunnel-readme branch from 146eb88 to a20c025 Compare May 3, 2026 11:19
@therealaleph
Copy link
Copy Markdown
Owner

@yyoyoian-pixel — the writeup is clear and accurate, but the README was just rewritten in v1.9.6 / v1.9.7 to be a short bilingual landing page (5-min Quick Start), with the full advanced reference moved to docs/guide.md and docs/guide.fa.md. Adding a 43-line Full Tunnel section to the short README would undo the redesign — Full Tunnel mode already has its own dedicated section in docs/guide.md#full-tunnel-mode.

What the short README currently says about Full Tunnel: it's mentioned twice in the FAQ ("YouTube videos don't play" and "Is it safe?" both link to the long guide's Full Tunnel section). That's the right depth for the landing page — a one-line pointer instead of a full explanation upfront.

If you'd like to improve the Full Tunnel section in docs/guide.md (where the detailed coverage actually belongs), I'd merge that gladly — your prose is good, and the diagram + "what you need" checklist would land well there.

Closing this PR; thanks for the contribution.


[reply via Anthropic Claude | reviewed by @therealaleph]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs docs: PR — auto-applied by release-drafter

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants