Skip to content

docs: add auto-generated code documentation#67

Merged
drQedwards merged 1 commit into
drQedwards:mainfrom
enesgules:codedocs/auto-generated
May 15, 2026
Merged

docs: add auto-generated code documentation#67
drQedwards merged 1 commit into
drQedwards:mainfrom
enesgules:codedocs/auto-generated

Conversation

@enesgules
Copy link
Copy Markdown

Auto-generated Code Documentation

AI-analyzed source code to produce structured documentation including:

  • Architecture overview with diagrams
  • Core concepts and internals
  • API reference with parameter tables
  • Practical usage guides

Browse the documentation →


Generated by Context7 · View docs

@vercel
Copy link
Copy Markdown

vercel Bot commented May 15, 2026

Someone is attempting to deploy a commit to the josefedwards-6907's projects Team on Vercel.

A member of the Team first needs to authorize it.

@drQedwards
Copy link
Copy Markdown
Owner

Add a "Plugin/Extension Development Guide" documenting how to register custom inbound and outbound protocol types (referencing the generic registration pattern in adapter/outbound/registry.go), how custom inbounds hand off connections to the router (as demonstrated in protocol/tun/inbound.go), and how the routing/rule engine dispatches connections to outbounds (as in route/route.go), including guidance on authentication/control-plane integration patterns and whether implementing a new inbound/outbound versus an external process is recommended for various use cases.

@drQedwards drQedwards merged commit a915ae0 into drQedwards:main May 15, 2026
5 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants