mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-14 00:26:06 +00:00
MHSanaei
9b91f0f42e
Fold the standalone 3x-ui-docs project (Next.js 16 + Fumadocs, deployed to docs.sanaei.dev) into docs/ so the panel and its documentation share a single source of truth, the way sing-box keeps its docs in-tree. The old repo becomes redundant and can be retired. - Import the full site under docs/ (app, components, content, lib, public, scripts, config). The self-contained pnpm project sits alongside the existing engineering notes with no filename collisions. - Re-point "Edit on GitHub" links from MHSanaei/3x-ui-docs to this repo's docs/content/docs path (docs/lib/shared.ts, docs/app/.../page.tsx). - Add docs-ci.yml and docs-deploy.yml under .github/workflows/, scoped to docs/** and run with working-directory: docs, since GitHub only runs workflows from the repo-root .github/. deploy-static.yml's GitHub Pages publish (CNAME docs.sanaei.dev) carries over unchanged. Follow-up (outside this commit): attach the docs.sanaei.dev custom domain to this repository's Pages (or set the Vercel project's root directory to docs), confirm the site is live from the monorepo, then delete MHSanaei/3x-ui-docs.
65 lines
1.9 KiB
Plaintext
65 lines
1.9 KiB
Plaintext
---
|
|
title: Contributing
|
|
description: How to contribute to 3x-ui and to translate this documentation.
|
|
icon: GitPullRequestArrow
|
|
---
|
|
|
|
3x-ui is community-driven. Contributions to the panel and to these docs are
|
|
welcome.
|
|
|
|
## Support the developer
|
|
|
|
3x-ui is free and open source, built and maintained in the open. If it's useful
|
|
to you, consider supporting continued development:
|
|
|
|
- **Donate** at [donate.sanaei.dev](https://donate.sanaei.dev/) — the page shows
|
|
current funding **goals and targets** you can help reach.
|
|
- **Star** the [repository](https://github.com/MHSanaei/3x-ui) and share the
|
|
project.
|
|
- **Join** the Telegram channel [@XrayUI](https://t.me/XrayUI) to follow news and
|
|
help others.
|
|
|
|
## Contribute to 3x-ui
|
|
|
|
- Read the project's `CONTRIBUTING.md` in the
|
|
[repository](https://github.com/MHSanaei/3x-ui).
|
|
- Open issues for bugs and feature requests with clear reproduction steps.
|
|
- Use Conventional Commits and keep pull requests focused.
|
|
|
|
## Translate the documentation
|
|
|
|
This site is built for translation. Content lives under `content/docs/<locale>/`
|
|
(`en`, `fa`, `ru`, `zh`), and untranslated pages **fall back to English**, so you
|
|
can translate incrementally.
|
|
|
|
<Steps>
|
|
|
|
<Step>
|
|
### Copy a page
|
|
|
|
Copy a page from `content/docs/en/...` to the same path under your locale, e.g.
|
|
`content/docs/fa/guide/installation.mdx`.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Translate the prose only
|
|
|
|
Translate the body and the frontmatter `title`/`description`. **Do not** translate
|
|
code, commands, environment variable names, protocol names, or share links.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Mind direction
|
|
|
|
Persian (`fa`) renders right-to-left. Keep code blocks and links left-to-right
|
|
(the layout already handles this), and check the page in both directions.
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
<Callout type="info">
|
|
Missing a page in your locale is fine — it falls back to English rather than
|
|
404ing. Translate the highest-traffic pages first (installation, first login,
|
|
REALITY).
|
|
</Callout>
|