Documentation Index

May 25, 2026 ยท View on GitHub

This directory is the canonical local documentation set for flutter_vless.

The package page on pub.dev is driven by the root README.md. These guides keep the longer setup, configuration, and troubleshooting material in one place without turning the pub.dev page into a wall of text.

Read This First

  1. Getting Started
  2. Platform Guides
  3. API Contract
  4. Examples
  5. Configuration Guide
  6. Compatibility
  7. Security And Runtime Boundaries
  8. Architecture Notes
  9. Real-Device VPN Matrix
  10. Troubleshooting

Audience Split

  • New users should start with getting-started.md, examples.md, and their platform guide.
  • Integrators should read api.md, configuration.md, and compatibility.md.
  • Maintainers should read architecture.md, security.md, and the macOS packet tunnel note before changing native runtime behavior.
  • Release validation should use device_matrix.md when VPN/tunnel behavior changes.
  • Debugging issues should usually begin with troubleshooting.md.

Notes

  • Keep this directory as the source of truth for human-written docs.
  • Use README.md for the pub.dev-facing summary and quick start.
  • Treat older root-level setup files as legacy during the transition to this docs layout.