From 1c54b4f4683ae6aa292c06689b923ae634f4c2ff Mon Sep 17 00:00:00 2001 From: KieranVR Date: Thu, 26 Mar 2026 10:28:03 -0700 Subject: [PATCH 1/3] update home page with a How Codex Works section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace accordions with tabs for core extensions, add an interactive architecture flowchart component, restructure the chart to show Foundation → Extension Sideloader → core extensions, and link the foundation card to the download page. Made-with: Cursor --- components/codex-architecture-chart.tsx | 136 ++++++++++++++++++++++++ content/docs/index.mdx | 100 ++++++++++------- mdx-components.tsx | 5 +- 3 files changed, 199 insertions(+), 42 deletions(-) create mode 100644 components/codex-architecture-chart.tsx diff --git a/components/codex-architecture-chart.tsx b/components/codex-architecture-chart.tsx new file mode 100644 index 0000000..8bf13d5 --- /dev/null +++ b/components/codex-architecture-chart.tsx @@ -0,0 +1,136 @@ +"use client"; + +function LayerConnector() { + return ( +
+
+
+ + + +
+
+ ); +} + +function LayerSection({ + label, + sublabel, + accent = false, + children, +}: { + label: string; + sublabel: string; + accent?: boolean; + children: React.ReactNode; +}) { + return ( +
+
+

{label}

+

{sublabel}

+
+
{children}
+
+ ); +} + +function ExtensionCard({ + name, + desc, + wide = false, + muted = false, +}: { + name: string; + desc: string; + wide?: boolean; + muted?: boolean; +}) { + return ( +
+

+ {name} +

+

{desc}

+
+ ); +} + + +export function CodexArchitectureChart() { + return ( +
+ + +

+ Codex Application +

+

+ Custom VS Code distribution (via VSCodium) with Open VSX marketplace +

+

+ Download for your platform → +

+ + + + + + +
+ + + + +
+ +
+ ); +} diff --git a/content/docs/index.mdx b/content/docs/index.mdx index 82c3fb8..1eb8411 100644 --- a/content/docs/index.mdx +++ b/content/docs/index.mdx @@ -1,42 +1,92 @@ --- title: Codex Editor Documentation -description: "Comprehensive documentation for Codex Editor - an AI-powered platform for collaborative translation projects. This site is a living document and subject to changes as we optimize the user experience for you." +description: "Comprehensive documentation for Codex Editor — an AI-powered platform for collaborative translation projects. This site is a living document and subject to changes as we optimize the user experience." --- # Welcome to Codex Editor -Codex Editor is a powerful AI-assisted translation platform designed to streamline multilingual translation workflows. Whether you're working on structured texts, literary works, subtitles, or other documents, Codex combines cutting-edge artificial intelligence with intuitive project management tools to help you create accurate, contextually appropriate translations. +Codex Editor is an AI-assisted translation platform that combines a powerful editor foundation with modular extensions for translation, collaboration, and quality assurance. Whether you're working on structured texts, literary works, subtitles, or other documents, Codex helps you create accurate, contextually appropriate translations. ## What is Codex Editor? -Codex Editor is an AI-powered translation tool that addresses the complex needs of translation projects worldwide. It integrates advanced features to make translation accessible to both novice and experienced translators, supporting: +Codex is an AI-powered translation tool built to handle the complex needs of translation projects worldwide. It supports: - **Global Accessibility**: Lowering barriers for translators in regions with limited resources - **Community Collaboration**: Enabling teams to work together across geographic and linguistic boundaries - **Cultural Sensitivity**: Allowing customization for specific domain and cultural contexts - **Quality Assurance**: Providing tools for validation, back translation, and consistency checking +## How Codex Works + +Codex is not a single monolithic application. It is a custom build of VS Code (through [VSCodium](https://github.com/VSCodium/vscodium)) that uses a **modular extension architecture** — each component owns a distinct responsibility, and together they form the full translation platform. + + + +### Core Extensions + +When you first launch Codex, a lightweight bootstrap extension called the **Extension Sideloader** automatically fetches and installs the core extensions from the [Open VSX](https://open-vsx.org/) marketplace. After installation, all extensions are available offline for subsequent launches. + + + + **Codex Translation Editor** — The heart of the platform. Provides the custom `.codex` notebook editor with a Quill-based cell editor supporting spellcheck and audio attachments, an embedded language server for spelling diagnostics, LLM-powered "smart edits" for AI-assisted translation and back-translation, and multiple webview panels for navigation, parallel passages, comments, project settings, and more. This is the extension users interact with directly when translating. + + + **Frontier Authentication** — Handles cloud identity and remote project lifecycle — user login and registration, GitLab-backed project sync (including auto-sync, merge conflict handling, and LFS support), and communication with the Frontier API for user accounts and sessions. Without this extension, users cannot log in, sync projects, or collaborate remotely. + + + **Shared State Store** — A small utility extension that provides reactive, persisted key-value state shared across all other extensions and webviews. The Translation Editor depends on it to synchronize context (current verse, active document, selection state, etc.) between its many panels without tight coupling. + + + **Extension Sideloader** — Developed and published to Open VSX as its own extension, but during the Codex build process its VSIX is downloaded and embedded directly into the binary — so it's available on first launch with no network. Its only job is to fetch a remote JSON manifest and trigger installation of the other extensions listed above. It has no UI of its own, and once the other extensions are installed it effectively becomes idle. + + + +### How Extensions Are Loaded + +Extensions reach a running Codex instance through two phases: + + + + ### Build Time — Bundled in the Binary + + All extensions (including the Sideloader) are developed in their own repositories and published to Open VSX independently. During CI/CD, the Codex build pipeline downloads the **Extension Sideloader** VSIX from Open VSX, unzips it into the VS Code extensions directory, and the platform packaging step bakes it into the final binary. This is the only extension embedded at build time — it's available immediately at first launch with no network required. + + + ### Runtime — Sideloaded on First Launch + + When Codex starts, the bundled Sideloader activates after startup finishes. It fetches an `extensions.json` manifest from GitHub, checks which extensions are missing, and installs them from the Open VSX gallery. On subsequent launches, extensions are already installed and no network is needed. + + + + + The Open VSX marketplace is configured during the build process via `product.json`. This is the same gallery used by VSCodium and other open-source VS Code distributions. + + +### Desktop Application + +Codex runs as a **desktop application** (Electron-based, like VS Code) on Windows, macOS, and Linux. + ## Key Features -### **AI-Powered Translation** +### AI-Powered Translation - Smart translation suggestions powered by advanced AI - Customizable AI instructions for style and accuracy - Batch prediction for efficient translation workflows - AI learns from your edits to improve over time -### **Collaboration & Project Management** +### Collaboration & Project Management - Team-based project sharing and management - Group creation with role-based permissions - Automatic synchronization across team members on configurable intervals - Version control and change tracking -### **Quality Assurance** +### Quality Assurance - Back translation generation for accuracy verification - Validation workflows for translation review - Consistency checking across translations - Phrase-level notes and annotations -### **Export & Integration** +### Export & Integration - Multiple export formats (plain text, HTML, USFM) - Integration with existing translation workflows - Project archiving and backup capabilities @@ -48,14 +98,11 @@ New to Codex Editor? Start here to set up your account and create your first tra Download Codex Editor to get started today! - - - Learn how to install and configure Codex Editor - - Set up your Codex Editor account and user profile + + Set up your account and configure Codex Editor - + Create and configure your first translation project @@ -63,7 +110,6 @@ New to Codex Editor? Start here to set up your account and create your first tra ## Core Workflows ### Translation Process -Master the essential translation workflows, from project setup to final validation. @@ -87,7 +133,6 @@ Master the essential translation workflows, from project setup to final validati ### Project Management -Collaborate effectively with teams and manage large-scale translation projects. @@ -98,29 +143,6 @@ Collaborate effectively with teams and manage large-scale translation projects. -## Use Cases - -### Language Teams -A language team translating educational, community, or reference content into a local dialect can use Codex to: -- Set up collaborative projects with native speakers -- Leverage AI suggestions while maintaining cultural relevance -- Use back translations to verify accuracy with community leaders -- Export translations for digital and print distribution - -### Scholarly Translation -Academic translators and scholars can utilize Codex for: -- Detailed segment-by-segment analysis with AI assistance -- Collaborative review processes with peer scholars -- Quality assurance through back translation verification -- Integration with existing research workflows - -### Community Projects -Local communities working on translation can benefit from: -- User-friendly interface accessible to non-technical users -- Collaborative features for community input and review -- AI assistance to accelerate the translation process -- Export capabilities for local distribution and use - ## Support & Resources - **Documentation**: Comprehensive guides for all features and workflows @@ -140,4 +162,4 @@ If something is not working, start with the troubleshooting flow before escalati --- -Ready to begin your translation journey? Start with our [Getting Started guide](/docs/getting-started/download-codex) or explore specific features in the [Translation](/docs/translation/ai-settings) section. +Ready to begin your translation journey? Start with our [Getting Started guide](/docs/getting-started/download-codex) or explore specific features in the [Translation](/docs/translation/translation-tools) section. diff --git a/mdx-components.tsx b/mdx-components.tsx index 6710a26..ae45792 100644 --- a/mdx-components.tsx +++ b/mdx-components.tsx @@ -1,10 +1,10 @@ import defaultMdxComponents from 'fumadocs-ui/mdx'; import { Cards, Card } from 'fumadocs-ui/components/card'; -import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; import { Step, Steps } from 'fumadocs-ui/components/steps'; import { LoomVideo } from '@/components/loom-video'; import { TroubleshootingFlow } from '@/components/troubleshooting-flow'; +import { CodexArchitectureChart } from '@/components/codex-architecture-chart'; import type { MDXComponents } from 'mdx/types'; import { ContributingNotice } from './components/contributing-notice'; @@ -14,14 +14,13 @@ export function getMDXComponents(components?: MDXComponents): MDXComponents { ...defaultMdxComponents, Cards, Card, - Accordion, - Accordions, Tab, Tabs, Step, Steps, LoomVideo, TroubleshootingFlow, + CodexArchitectureChart, ContributingNotice, ...components, }; From 539209a91457dbe8820ba9ecdbf9edc594e3e735 Mon Sep 17 00:00:00 2001 From: KieranVR Date: Thu, 26 Mar 2026 10:45:55 -0700 Subject: [PATCH 2/3] restore Accordion components used by other pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Other pages (releases, download, translation-tools, etc.) still use Accordion components — only the home page was migrated to Tabs. Made-with: Cursor --- mdx-components.tsx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mdx-components.tsx b/mdx-components.tsx index ae45792..a95f389 100644 --- a/mdx-components.tsx +++ b/mdx-components.tsx @@ -1,5 +1,6 @@ import defaultMdxComponents from 'fumadocs-ui/mdx'; import { Cards, Card } from 'fumadocs-ui/components/card'; +import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; import { Step, Steps } from 'fumadocs-ui/components/steps'; import { LoomVideo } from '@/components/loom-video'; @@ -14,6 +15,8 @@ export function getMDXComponents(components?: MDXComponents): MDXComponents { ...defaultMdxComponents, Cards, Card, + Accordion, + Accordions, Tab, Tabs, Step, From 910b2092226e81bc863bbbcce933f8441dd89977 Mon Sep 17 00:00:00 2001 From: KieranVR Date: Thu, 26 Mar 2026 10:55:54 -0700 Subject: [PATCH 3/3] use Next.js Link instead of raw anchor tag Fixes ESLint no-html-link-for-pages error in the architecture chart. Made-with: Cursor --- components/codex-architecture-chart.tsx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/components/codex-architecture-chart.tsx b/components/codex-architecture-chart.tsx index 8bf13d5..1217fc7 100644 --- a/components/codex-architecture-chart.tsx +++ b/components/codex-architecture-chart.tsx @@ -1,5 +1,7 @@ "use client"; +import Link from "next/link"; + function LayerConnector() { return (
@@ -86,7 +88,7 @@ export function CodexArchitectureChart() { label="Foundation" sublabel="Desktop application for Windows, macOS, and Linux" > - @@ -99,7 +101,7 @@ export function CodexArchitectureChart() {

Download for your platform →

- +