3x-ui/docs/panel-guide/README.md
2026-02-18 21:37:15 +03:30

46 lines
1.7 KiB
Markdown

# 3x-ui Guide Index
This folder is the focused replacement for the monolithic `PANEL_GUIDE_SOURCE_OF_TRUTH.md`.
## Files
1. `01-overview-and-architecture.md`
2. `02-pages-and-operations.md`
3. `03-api-and-cli-reference.md`
4. `04-security-and-hardening.md`
5. `05-client-management-model.md`
6. `06-custom-client-center-feature.md`
7. `07-dev-and-testing-workflow.md`
8. `08-protocols-and-config-analysis.md`
9. `09-xray-protocol-reference.md`
10. `10-glossary-and-concepts.md`
11. `11-troubleshooting-runbook.md`
12. `12-change-management-and-rollout.md`
13. `13-feature-file-map-and-decision-log.md`
14. `14-marzban-inspired-roadmap.md`
15. `15-remnawave-hiddify-analysis.md`
16. `16-unified-product-roadmap.md`
17. `99-session-context-transfer-2026-02-18.md`
## Recommended read order
1. Read `01` for system model.
2. Read `02` for operator actions.
3. Read `04` before internet exposure.
4. Read `05` and `06` for client strategy.
5. Read `07` for local dev/test workflow.
6. Read `08` for protocol conversion and sample-config interpretation.
7. Read `09` for protocol reference and compatibility guidance.
8. Read `10` for shared terminology and mental models.
9. Read `11` for incident/debug operation.
10. Read `12` before any risky rollout/migration.
11. Read `13` before modifying custom feature code.
12. Read `14` for Marzban-inspired implementation roadmap.
13. Read `15` for Remnawave + Hiddify inspiration and adoption phases.
14. Read `16` for the complete unified execution roadmap.
15. Read `99` for full session handoff context.
## Scope note
- These files reflect current repository state and live validation work done on 2026-02-18.
- For historical context and raw long-form notes, keep `PANEL_GUIDE_SOURCE_OF_TRUTH.md` as archive.