mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-09 06:06:08 +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.
41 lines
1.6 KiB
TypeScript
41 lines
1.6 KiB
TypeScript
export const appName = '3x-ui';
|
|
export const appTagline = 'Advanced web panel for managing Xray-core servers';
|
|
|
|
export const docsRoute = '/docs';
|
|
export const docsImageRoute = '/og/docs';
|
|
export const docsContentRoute = '/llms.mdx/docs';
|
|
|
|
// The 3x-ui product repository — used for the navbar GitHub link,
|
|
// build-time star/release stats, and install commands.
|
|
export const productRepo = {
|
|
user: 'MHSanaei',
|
|
repo: '3x-ui',
|
|
branch: 'main',
|
|
};
|
|
|
|
// Where these docs live in the 3x-ui monorepo — used for "Edit on GitHub" links.
|
|
export const gitConfig = {
|
|
user: 'MHSanaei',
|
|
repo: '3x-ui',
|
|
branch: 'main',
|
|
docsDir: 'docs/content/docs',
|
|
};
|
|
|
|
export const productRepoUrl = `https://github.com/${productRepo.user}/${productRepo.repo}`;
|
|
|
|
// AI-generated interactive wiki of the 3x-ui codebase.
|
|
export const deepWikiUrl = `https://deepwiki.com/${productRepo.user}/${productRepo.repo}`;
|
|
|
|
// Official 3x-ui community channel on Telegram (announcements & support).
|
|
export const telegramChannel = 'XrayUI';
|
|
export const telegramChannelUrl = `https://t.me/${telegramChannel}`;
|
|
|
|
// Support the developer — donation page with funding goals/targets.
|
|
export const donateUrl = 'https://donate.sanaei.dev/';
|
|
|
|
// Public site origin, used for metadataBase / canonical URLs / OG images.
|
|
// Defaults to the production domain, so the env var is optional. Use `||` (not
|
|
// `??`) so an empty string — e.g. an unset `${{ vars.NEXT_PUBLIC_SITE_URL }}`
|
|
// in CI — also falls back instead of shipping a blank origin.
|
|
export const siteUrl = process.env.NEXT_PUBLIC_SITE_URL || 'https://docs.sanaei.dev';
|