contributing.mdx 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. ---
  2. title: Contributing
  3. description: How to contribute to 3x-ui and to translate this documentation.
  4. icon: GitPullRequestArrow
  5. ---
  6. 3x-ui is community-driven. Contributions to the panel and to these docs are
  7. welcome.
  8. ## Support the developer
  9. 3x-ui is free and open source, built and maintained in the open. If it's useful
  10. to you, consider supporting continued development:
  11. - **Donate** at [donate.sanaei.dev](https://donate.sanaei.dev/) — the page shows
  12. current funding **goals and targets** you can help reach.
  13. - **Star** the [repository](https://github.com/MHSanaei/3x-ui) and share the
  14. project.
  15. - **Join** the Telegram channel [@XrayUI](https://t.me/XrayUI) to follow news and
  16. help others.
  17. ## Contribute to 3x-ui
  18. - Read the project's `CONTRIBUTING.md` in the
  19. [repository](https://github.com/MHSanaei/3x-ui).
  20. - Open issues for bugs and feature requests with clear reproduction steps.
  21. - Use Conventional Commits and keep pull requests focused.
  22. ## Translate the documentation
  23. This site is built for translation. Content lives under `content/docs/<locale>/`
  24. (`en`, `fa`, `ru`, `zh`), and untranslated pages **fall back to English**, so you
  25. can translate incrementally.
  26. <Steps>
  27. <Step>
  28. ### Copy a page
  29. Copy a page from `content/docs/en/...` to the same path under your locale, e.g.
  30. `content/docs/fa/guide/installation.mdx`.
  31. </Step>
  32. <Step>
  33. ### Translate the prose only
  34. Translate the body and the frontmatter `title`/`description`. **Do not** translate
  35. code, commands, environment variable names, protocol names, or share links.
  36. </Step>
  37. <Step>
  38. ### Mind direction
  39. Persian (`fa`) renders right-to-left. Keep code blocks and links left-to-right
  40. (the layout already handles this), and check the page in both directions.
  41. </Step>
  42. </Steps>
  43. <Callout type="info">
  44. Missing a page in your locale is fine — it falls back to English rather than
  45. 404ing. Translate the highest-traffic pages first (installation, first login,
  46. REALITY).
  47. </Callout>