Skip to content

docs: add office sdk overview and feature guides - #150

Open
DR-Univer wants to merge 29 commits into
devfrom
feat/office-sdk-overview
Open

DR-Univer wants to merge 29 commits into
devfrom
feat/office-sdk-overview

Conversation

@DR-Univer

@DR-Univer DR-Univer commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Summary

Add an Office SDK documentation hub that explains how Web SDK, Server SDK and AI SDK work together, with product capability catalogs, technical guides and runnable application examples.

  • Add Overview, Get started, Features and Examples, homepage entry points, flat SDK navigation, scoped navigation/search, collapsible feature groups and active-page navigation.

  • Cover six products, 76 categories, 405 features and 43 chart types, with Microsoft Office and Google Workspace comparisons, support filters and open-source badges. Expand 15 shared-capability guides with source-based explanations, diagrams, API links, code and real screenshots.

  • Publish Overview, the feature overview, six product catalogs and the chart catalog in all eight site languages. Add 54 translations for Traditional Chinese, Japanese, Korean, French, Russian and Spanish instead of English fallback. Preserve fragment links, feature order, support/source flags, chart previews and comparison-filter semantics. Keep SDK/API identifiers and vendor names intact.

  • Use CLI in example titles/navigation and Univer CLI as the full project name across all eight locales. Explain CLI (Command-Line Interface) and its commands/Skills workflow, replacing the earlier MCP-first approach. Preserve the univer-cli package/repository, univer commands, Skill identifiers and existing routes/fragments.

  • Expand Workspace and the DeepSeek Harness, WorkBuddy and OpenClaw plugin examples with installation, Skills and tasks. Consolidate Workspace and Desktop into hosted trial → existing agents through Workspace CLI → private deployment → Desktop creation/review → repository customization. Preserve former Desktop routes and localized fragments.

  • Add Office Lab after Workspace: Team Invitations requirements, Issue, Worktree PR, native Compare, delivery scheduling, Web Apps, Pages and team settings. Include three localized Agent task templates, seven English cloud screenshots and a genuine cloud tour showing Wiki → Repository mode, a document, Issue, Ready PR, expanded Compare and working Web App.

  • Provide a richer Team Access Console HTML prototype with fictional teammates, roles, search/status filters, invitations/cancellation, activity and session counters. Retain real Desktop captures of five content types, conversation with live preview, Space organization, same-account Web/Desktop synchronization, sharing, Worktree/Compare and a bound dashboard.

  • Publish localized agent Markdown and llms indexes, and document translation/parity conventions in the README.

  • Align formatter/lint Tailwind sorting with the existing stylesheet and preserve static-parameter behavior. Move public Office SDK routes under /overview, restore navigation controls and remove the unused SDK Prompt proxy/component.

  • Use Relational Table and Canvases (with localized labels) throughout the Office SDK overview, feature guides and examples. Remove 144 repetitive SDK-name crosswalk paragraphs and redundant inline explanations, while preserving SDK/API identifiers, executable examples, comparison facts and existing heading links.

Validation

Product naming (fe50ef00):

  • Compiled all 160 changed MDX sources and preserved existing heading IDs; the three product-navigation JSON files pass formatting.
  • 20 existing source/navigation tests passed. Verified feature/support/source flags, differences-filter relationships, executable code blocks, URL targets and comparison-vendor wording against the preceding commit.
  • 32 HTML/agent Markdown routes passed across eight overview languages plus representative English/Chinese feature and Workspace pages. The repeated name notes are absent, Canvases labels are consistent and legacy Compare fragments still resolve.
  • Synchronized local dependencies from the unchanged lockfile before preview verification. This follow-up changes content only; no full-site production build was repeated.
  • GitHub Actions Test/lint passed for fe50ef008c22572c48c297db0eec214147c90ebb.

CLI naming checks (8427df55):

  • Compiled all 16 changed MDX sources with the project configuration.
  • Example/sidebar regression tests passed 6/6.
  • Verified 32 HTML/agent Markdown routes across eight locales: CLI title/menu, full Univer CLI introduction, Command-Line Interface explanation and example-index entry. No obsolete product-name references remain in these sources.
  • Confirmed all links, fragment IDs, install commands and Skills content are unchanged; git diff --check passed.
  • GitHub Actions Test/lint passed for 8427df55a636c30c53fb002d38394f472e32a876.
  • This follow-up changes documentation text only. The full-site build and executable-code checks below were completed on the preceding i18n commit, rather than repeated for the naming edit.

Preceding i18n/code checks (09014ed5):

  • pnpm build passed, generating 11,254 static pages. pnpm typecheck passed separately; the existing build configuration skips type validation.
  • pnpm lint passed; changed executable files had zero warnings, with unrelated repository warnings remaining. Formatting passed for 82 changed code/config/style files.
  • 17/17 regressions passed on the production preview, including search, navigation, redirects, examples, sidebar behavior and translated content.
  • Verified 144 HTML/Markdown routes for nine page families × eight locales, including native titles, category anchors and rendered tables.
  • Catalog parity checks preserve every category, feature, support/open-source flag, link, chart preview and summary relationship used by the differences filter. All eight UI catalogs have 476 matching keys and interpolation variables.
  • Parsed all eight overview diagrams: correct dependencies, seven edges and no self-loops. Browser checks confirmed the Japanese diagram and French search, differences-only, open-source-only and reset interactions.
  • GitHub Actions Test/lint passed for that commit.

Earlier branch checks covered the real cloud tour/media, invitation-model behavior, Workspace compatibility routes/indexes, same-account Web/Desktop synchronization and dashboard recalculation. The cloud demonstration PR remains Ready and unmerged.

Pre-Landing Review

Corrected and verified diagram dependencies, technical identities, record-comment/cross-Base labels and Japanese PDF scope/Portfolio wording. The product-naming follow-up changes only Office SDK MDX and product-navigation metadata; executable examples, SDK/API identifiers, links and heading IDs remain intact.

Scope and preview details

CLI means Command-Line Interface. The project is Univer CLI; its concise menu label is CLI. Existing MCP-specific host integrations are not removed.

New catalog translations were machine-assisted and technically reviewed; native-speaker editorial review has not been completed. Existing English/Chinese support facts are preserved, including external OCR requirements and PDF comparison scope.

Office Lab Repository mode is experimental and Issues belong to Team Spaces. Office Worktree review/merge and HTML View publication have separate flows; the Pages default is browser-local. The Team Access Console is an in-memory demonstration, not live membership, email delivery, analytics or Office data binding. Maya/Codex and Alex/Claude Code are suggested roles, not a claim that both external agents performed the captured run.

The earlier Desktop preview uses local configuration and a read-only comparison adapter; Apply/merge is not validated by that adapter. Production installation, separate-account collaboration, Windows/Linux installers and external example authentication were not rerun. Three existing Playwright tests were not rerun in these follow-ups; browser interaction checks used the available in-app browser.

The product-naming follow-up includes only Office SDK content and product-navigation metadata. Installers, service data, credentials, plugin/host modifications, local helpers, generated builds and submodule changes remain excluded.

DR-Univer and others added 27 commits October 27, 2026 22:31
Co-Authored-By: OpenAI Codex <noreply@openai.com>
@DR-Univer
DR-Univer requested a review from jikkai October 28, 2026 10:44
@DR-Univer DR-Univer changed the title v1.2.0 docs: add Office SDK hub and feature documentation feat(docs): add Office SDK hub and feature documentation Oct 28, 2026
@DR-Univer DR-Univer changed the title feat(docs): add Office SDK hub and feature documentation docs(office): add Office SDK hub and feature documentation Oct 28, 2026
@jikkai jikkai changed the title docs(office): add Office SDK hub and feature documentation docs: add office sdk overview and feature guides Oct 28, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants