fix(docs-base): move default docs to versioned path (4ee1fb9) and update UI links to avoid latest alias breakage

Faxbot Agent · Faxbot Agent · commit 7e84306fb033 · 2025-10-06T00:57:11.000-06:00
diff --git a/api/admin_ui/src/components/Diagnostics.tsx b/api/admin_ui/src/components/Diagnostics.tsx
@@ -183,7 +183,7 @@ function Diagnostics({ client, onNavigate, docsBase }: DiagnosticsProps) {
   useEffect(() => {
     const loadAnchors = async () => {
       try {
-        const base = docsBase || 'https://docs.faxbot.net/latest';
+        const base = docsBase || 'https://docs.faxbot.net/4ee1fb94';
         const topics: string[] = [ 'security', 'diagnostics', 'inbound', 'storage', 'plugins', 'mcp', 'scripts', 'setup', 'send', 'jobs', 'tunnels', 'keys', 'logs', 'sip', 'signalwire', 'freeswitch', 'documo' ];
         const provs = [active?.outbound, active?.inbound].filter(Boolean) as string[];
         for (const p of provs) { if (!topics.includes(p)) topics.push(p); }
@@ -373,41 +373,41 @@ function Diagnostics({ client, onNavigate, docsBase }: DiagnosticsProps) {
         docs.push({ text: 'FAX_DATA_DIR stores temporary files and fax artifacts.' });
         docs.push({ text: 'Default: /faxdata in container, ./faxdata locally' });
         docs.push({ text: 'Must be writable by the application process.' });
-        docs.push({ text: 'Deployment Guide', href: `${docsBase || 'https://docs.faxbot.net/latest'}/deployment/` });
+        docs.push({ text: 'Deployment Guide', href: `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/deployment/` });
       }
       else if (key === 'database_connected') {
         docs.push({ text: 'Database stores job records and API keys.' });
         docs.push({ text: 'Default: SQLite at ./faxbot.db' });
         docs.push({ text: 'Production: Use PostgreSQL with DATABASE_URL' });
-        docs.push({ text: 'Database Setup', href: `${docsBase || 'https://docs.faxbot.net/latest'}/deployment/` });
+        docs.push({ text: 'Database Setup', href: `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/deployment/` });
       }
     }
     
     if (t.includes('phaxio')) {
-      docs.push({ text: 'Phaxio Setup Guide', href: `${docsBase || 'https://docs.faxbot.net/latest'}/setup/phaxio/` });
+      docs.push({ text: 'Phaxio Setup Guide', href: `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/phaxio/` });
       docs.push({ text: 'Phaxio Console', href: 'https://console.phaxio.com' });
       const add = (topic: string, text: string) => { const href = anchors[topic] || thirdParty[topic]; if (href) docs.push({ text, href }); };
       add('phaxio-webhook-hmac', 'Verify Phaxio inbound HMAC signatures');
       add('phaxio-status-callback-url', 'Set status callback URL (HTTPS required)');
     }
     
     if (t.includes('sip')) {
-      docs.push({ text: 'SIP/Asterisk Setup', href: `${docsBase || 'https://docs.faxbot.net/latest'}/setup/sip-asterisk/` });
+      docs.push({ text: 'SIP/Asterisk Setup', href: `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/sip-asterisk/` });
       if (key === 'ami_password_not_default') {
         docs.push({ text: 'Change AMI password in both Asterisk manager.conf and ASTERISK_AMI_PASSWORD env var.' });
       }
     }
     
     if (t.includes('security')) {
-      docs.push({ text: 'Security Guide', href: `${docsBase || 'https://docs.faxbot.net/latest'}/security/` });
+      docs.push({ text: 'Security Guide', href: `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/security/` });
       const addSec = (topic: string, text: string) => { const href = anchors[topic] || thirdParty[topic]; if (href) docs.push({ text, href }); };
       addSec('enforce-https-phi', 'Enforce HTTPS for PHI (ENFORCE_PUBLIC_HTTPS)');
       addSec('require-api-key-production', 'Require API keys (REQUIRE_API_KEY)');
       addSec('audit-logging-hipaa', 'Enable audit logging');
     }
 
     if (t.includes('sinch')) {
-      docs.push({ text: 'Faxbot: Sinch Setup', href: `${docsBase || 'https://docs.faxbot.net/latest'}/setup/sinch/` });
+      docs.push({ text: 'Faxbot: Sinch Setup', href: `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/sinch/` });
       docs.push({ text: 'Sinch Fax API', href: 'https://developers.sinch.com/docs/fax/api-reference/' });
       docs.push({ text: 'OAuth 2.0 for Fax API', href: 'https://developers.sinch.com/docs/fax/api-reference/authentication/oauth/' });
       docs.push({ text: 'Sinch Customer Dashboard (Access Keys – Build)', href: 'https://dashboard.sinch.com/settings/access-keys' });
@@ -423,7 +423,7 @@ function Diagnostics({ client, onNavigate, docsBase }: DiagnosticsProps) {
     }
 
     if (t.includes('inbound')) {
-      docs.push({ text: 'Inbound Overview', href: `${docsBase || 'https://docs.faxbot.net/latest'}/inbound/` });
+      docs.push({ text: 'Inbound Overview', href: `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/inbound/` });
       const addI = (topic: string, text: string) => { const href = anchors[topic] || thirdParty[topic]; if (href) docs.push({ text, href }); };
       addI('inbound-enable', 'Enable inbound receiving');
       addI('inbound-retention', 'Retention days');
@@ -433,7 +433,7 @@ function Diagnostics({ client, onNavigate, docsBase }: DiagnosticsProps) {
     }
 
     if (t.includes('storage')) {
-      docs.push({ text: 'Storage Guide', href: `${docsBase || 'https://docs.faxbot.net/latest'}/operations/` });
+      docs.push({ text: 'Storage Guide', href: `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/operations/` });
       const addSt = (topic: string, text: string) => { const href = anchors[topic] || thirdParty[topic]; if (href) docs.push({ text, href }); };
       addSt('storage-local-vs-s3', 'Local vs S3');
       addSt('storage-s3-kms', 'S3 KMS encryption');
diff --git a/api/admin_ui/src/components/Inbound.tsx b/api/admin_ui/src/components/Inbound.tsx
@@ -67,7 +67,7 @@ function Inbound({ client, docsBase }: InboundProps) {
   const [faxToDelete, setFaxToDelete] = useState<string | null>(null);
   const [deleting, setDeleting] = useState(false);
   // Precise help anchors (lightweight resolver for inbound failures)
-  const base = docsBase || 'https://docs.faxbot.net/latest';
+  const base = docsBase || 'https://docs.faxbot.net/4ee1fb94';
   const anchors: Record<string,string> = {
     // Our docs pages
     'inbound-overview': `${base}/inbound/`,
@@ -381,7 +381,7 @@ function Inbound({ client, docsBase }: InboundProps) {
           You are not authorized to view inbound faxes. Use an API key with inbound:list and inbound:read.
           <Box sx={{ mt: 1, display: 'flex', gap: 1, flexWrap: 'wrap' }}>
             <Button size="small" variant="outlined" onClick={() => window.dispatchEvent(new CustomEvent('faxbot:navigate', { detail: 'settings/keys' }))}>Open API Keys</Button>
-            <Button size="small" href={(docsBase || 'https://docs.faxbot.net/latest') + '/admin-console/api-keys/'} target="_blank" rel="noreferrer">Learn more</Button>
+            <Button size="small" href={(docsBase || 'https://docs.faxbot.net/4ee1fb94') + '/admin-console/api-keys/'} target="_blank" rel="noreferrer">Learn more</Button>
           </Box>
         </Alert>
       )}
@@ -603,7 +603,7 @@ same => n,System(curl -s -X POST -H "Content-Type: application/json" -H "X-Inter
                   </Button>
                   <Button 
                     size="small" 
-                    href={`${docsBase || 'https://docs.faxbot.net/latest'}/setup/sip-asterisk/`} 
+                    href={`${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/sip-asterisk/`} 
                     target="_blank" 
                     rel="noreferrer"
                     fullWidth={isSmallMobile}
diff --git a/api/admin_ui/src/components/ScriptsTests.tsx b/api/admin_ui/src/components/ScriptsTests.tsx
@@ -205,7 +205,7 @@ const ScriptsTests: React.FC<Props> = ({ client, docsBase, readOnly = false, can
 
   const theme = useTheme();
 
-  const docsUrl = useMemo(() => `${docsBase || 'https://docs.faxbot.net/latest'}/tools/scripts-and-tests/`, [docsBase]);
+  const docsUrl = useMemo(() => `${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/tools/scripts-and-tests/`, [docsBase]);
 
   const pushAuth = (line: string) => setAuthLines((prev) => [...prev, line]);
   const clearAuth = () => setAuthLines([]);
diff --git a/api/admin_ui/src/components/Settings.tsx b/api/admin_ui/src/components/Settings.tsx
@@ -53,7 +53,7 @@ function Settings({ client, readOnly = false }: SettingsProps) {
   const [restartHint, setRestartHint] = useState<boolean>(false);
   const [allowRestart, setAllowRestart] = useState<boolean>(false);
   const [persistedEnabled, setPersistedEnabled] = useState<boolean>(false);
-  const [docsBase, setDocsBase] = useState<string>('https://docs.faxbot.net/latest');
+  const [docsBase, setDocsBase] = useState<string>('https://docs.faxbot.net/4ee1fb94');
   const [migrationBanner, setMigrationBanner] = useState<boolean>(false);
   const [importingEnv, setImportingEnv] = useState<boolean>(false);
   const [importResult, setImportResult] = useState<{discovered:number; prefixes:string[]} | null>(null);
diff --git a/api/admin_ui/src/components/SetupWizard.tsx b/api/admin_ui/src/components/SetupWizard.tsx
@@ -487,7 +487,7 @@ function SetupWizard({ client, onDone, docsBase }: SetupWizardProps) {
               <Grid container spacing={2}>
                 <Grid item xs={12}>
                   <Typography variant="body2" color="text.secondary">
-                    See <a href={`${docsBase || 'https://docs.faxbot.net/latest'}/setup/sinch/`} target="_blank" rel="noreferrer">Faxbot: Sinch Setup</a> or the <a href="https://developers.sinch.com/docs/fax/api-reference/" target="_blank" rel="noreferrer">Sinch Fax API docs</a>.
+                    See <a href={`${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/sinch/`} target="_blank" rel="noreferrer">Faxbot: Sinch Setup</a> or the <a href="https://developers.sinch.com/docs/fax/api-reference/" target="_blank" rel="noreferrer">Sinch Fax API docs</a>.
                   </Typography>
                 </Grid>
                 <Grid item xs={12}>
@@ -793,7 +793,7 @@ function SetupWizard({ client, onDone, docsBase }: SetupWizardProps) {
                       Paste this URL into your {(config.inbound_backend || config.outbound_backend || config.backend || 'phaxio').toUpperCase()} console for inbound fax delivery. For Sinch, set the webhook content type to application/json. Learn more:
                     </Typography>
                     <Box sx={{ mt: 1, display: 'flex', gap: 1, flexWrap: 'wrap' }}>
-                      <Button size="small" variant="outlined" href={`${docsBase || 'https://docs.faxbot.net/latest'}/setup/sinch/`} target="_blank" rel="noreferrer">Faxbot: Sinch Setup</Button>
+                      <Button size="small" variant="outlined" href={`${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/sinch/`} target="_blank" rel="noreferrer">Faxbot: Sinch Setup</Button>
                       <Button size="small" variant="outlined" href={`https://developers.sinch.com/docs/fax/api-reference/`} target="_blank" rel="noreferrer">Sinch Fax API Docs</Button>
                       <Button size="small" variant="outlined" href={`https://dashboard.sinch.com/settings/access-keys`} target="_blank" rel="noreferrer">Sinch Access Keys</Button>
                     </Box>
@@ -951,7 +951,7 @@ function SetupWizard({ client, onDone, docsBase }: SetupWizardProps) {
                       </Box>
                     ))}
                     <Typography variant="caption" color="text.secondary">
-                      Help: <a href={`${docsBase || 'https://docs.faxbot.net/latest'}/setup/phaxio/`} target="_blank" rel="noreferrer">Faxbot: Phaxio</a> • <a href={`${docsBase || 'https://docs.faxbot.net/latest'}/setup/signalwire/`} target="_blank" rel="noreferrer">Faxbot: SignalWire</a> • <a href={`${docsBase || 'https://docs.faxbot.net/latest'}/setup/freeswitch/`} target="_blank" rel="noreferrer">Faxbot: FreeSWITCH</a> • <a href="https://developers.sinch.com/docs/fax/api-reference/" target="_blank" rel="noreferrer">Sinch Fax API</a>
+                      Help: <a href={`${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/phaxio/`} target="_blank" rel="noreferrer">Faxbot: Phaxio</a> • <a href={`${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/signalwire/`} target="_blank" rel="noreferrer">Faxbot: SignalWire</a> • <a href={`${docsBase || 'https://docs.faxbot.net/4ee1fb94'}/setup/freeswitch/`} target="_blank" rel="noreferrer">Faxbot: FreeSWITCH</a> • <a href="https://developers.sinch.com/docs/fax/api-reference/" target="_blank" rel="noreferrer">Sinch Fax API</a>
                     </Typography>
                   </Box>
                 )}
diff --git a/api/app/main.py b/api/app/main.py
@@ -1214,7 +1214,7 @@ def get_admin_config():
         "phaxio_verify_signature": settings.phaxio_verify_signature,
         "persisted_settings_enabled": (os.getenv("ENABLE_PERSISTED_SETTINGS", "false").lower() in {"1","true","yes"}),
         "branding": {
-            "docs_base": os.getenv("DOCS_BASE_URL", "https://docs.faxbot.net/latest"),
+            "docs_base": os.getenv("DOCS_BASE_URL", "https://docs.faxbot.net/4ee1fb94"),
             "logo_path": "/admin/ui/faxbot_full_logo.png",
         },
         "migration": {
@@ -1681,7 +1681,7 @@ async def admin_ui_config(request: Request):
             "auth_refresh": "/auth/refresh",
         },
         # client can render docs links relative to this base
-        "docs_base": os.getenv("DOCS_BASE_URL", "https://docs.faxbot.net/latest"),
+        "docs_base": os.getenv("DOCS_BASE_URL", "https://docs.faxbot.net/4ee1fb94"),
     }
     body = json.dumps(cfg, sort_keys=True).encode("utf-8")
     etag = hashlib.sha256(body).hexdigest()
