diff --git a/README.md b/README.md index 39198133..2c62ed87 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,73 @@ mintlify dev Use the [Paste Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image) extension to paste images into the markdown file. Open mdx file and press `cmd + option + v` to paste image. +### Image Assets + +Images are shared repo assets. Keep paths stable, names searchable, and +rendering consistent. + +When a change includes images, ask the agent to read this section first and +commit only images processed according to these rules. + +#### Folder Rules + +- Use `images/{top-level-group}/{topic}/`. +- Top-level groups: `docs`, `selfhosted`, `api`, `security`, `changelog`. +- `docs` maps to the Help Center Docs tab. Do not flatten + `images/docs/{topic}/` into `images/{topic}/`. +- `{topic}` maps to the navigation name in `docs.json`, such as `ai`, `base`, + `space`, `sso`, `authority-matrix`, `get-id`, `sql-query`, or `activate`. +- Do not put new screenshots in the `images/` root. +- Do not commit random staging folders. +- Put unreferenced images in `images/orphans/YYYY-MM-DD/...` first. Do not + delete them directly. +- Docs pages must not reference `images/orphans/...`. + +#### Naming + +Use this format: + +```text +images/{top-level-group}/{topic}/YYYY-MM-DD-page-slug-purpose.png +images/{top-level-group}/{topic}/YYYY-MM-DD-page-slug-purpose.webp +images/{top-level-group}/{topic}/YYYY-MM-DD-page-slug-purpose-zh.png +``` + +- Date = day the image enters the docs repo. +- Page slug = docs page or feature area. +- Purpose = visible UI or action. Do not use `image1` or random hashes. +- Use `.png` for static UI screenshots. +- Prefer `.webp` for animated screenshots. +- English-only screenshot = shared asset. Do not add `-en`. +- Chinese-specific screenshot = add `-zh`. + +#### Image Handling + +- Logos, inline icons, external button images, videos, and historical changelog + media do not need screenshot styling. + +#### MDX Usage + +Use explicit `` for docs screenshots: + +```mdx +AI Chat context selector +``` + +- Use `className="docs-screenshot"` for new PNG/WebP docs screenshots under + `images/docs/`, `images/api/`, `images/selfhosted/`, and `images/security/`. +- Alt text must be non-empty. +- Alt text describes the visible UI or action. Do not use `screenshot` or the + file name. +- Do not use `![](...)` for new docs screenshots. +- Avoid `width="400"`, percentage widths, and one-off image sizing. +- Changelog images keep their historical display. Add useful alt text when + context exists. Do not add `docs-screenshot` blindly. + ### Publishing Changes Push to origin main branch, the changes will be deployed to production automatically. diff --git a/en/api-doc/get-id.mdx b/en/api-doc/get-id.mdx index a3fa655d..7c9f5112 100644 --- a/en/api-doc/get-id.mdx +++ b/en/api-doc/get-id.mdx @@ -6,25 +6,41 @@ title: "Getting IDs" Click on the target space and copy the string starting with 'spc' from the URL, example: `spcXXXXXXXXXX` -![](/images/2026-02-12-10-43-08.png) +Space ID in the URL ## BaseId Click on the target base and copy the string starting with 'bse' from the URL, example: `bseXXXXXXXXXX` -![](/images/2026-02-12-10-46-49.png) +Base ID in the URL ## TableId Click on the target table and copy the string starting with 'tbl' from the URL, example: `tblXXXXXXXXXX` -![](/images/2026-02-12-10-48-18.png) +Table ID in the URL ## ViewId Click on the target view and copy the string starting with 'viw' from the URL, example: `viwXXXXXXXXXX` -![](/images/2026-02-12-10-48-11.png) +View ID in the URL ## FieldId @@ -32,21 +48,41 @@ Click on the target view and copy the string starting with 'viw' from the URL, e Click the "More" icon (three dots) in the top left corner, then select "Design" to enter the design interface and view all field IDs - +Open the design page from the More menu -![](/images/2025-02-14-18-16-26.png) +Field IDs in the design page **Method 2:** Double-click the column header or select "Edit field" to open the field properties. In the "DB field name" section, you can find the Field ID. - +Open field settings from the column menu - +DB field name with the field ID ## RecordId Expand the record edit form and copy the string starting with 'rec' after 'recordId=' in the URL, example: `recXXXXXXXXXX` -![](/images/2026-02-12-10-55-17.png) +Record ID in the expanded record URL diff --git a/en/api-doc/sql-query.mdx b/en/api-doc/sql-query.mdx index 982421f9..42cda7ba 100644 --- a/en/api-doc/sql-query.mdx +++ b/en/api-doc/sql-query.mdx @@ -14,18 +14,30 @@ Teable allows you to connect to its underlying PostgreSQL database through exter 1. **Open a Table**: First, open any table within the base you want to connect to. 2. **Enter Design Page**: Click the ⚙️ icon in the top right corner to enter the Base Design page. -![](/images/2025-12-05-01-16-08.png) +Open the Base Design page 3. **Find Database Connection Panel**: In the Design page, locate the "Database Connection" panel. 4. **Create Connection**: Click create, and the system will automatically generate a read-only PostgreSQL connection with username, password, and host address. -![](/images/2025-12-05-01-17-53.png) +Database Connection panel ### Connecting to the Database Use the credentials to connect through your preferred tool. Here's an example: -Connection example +External database connection example ### Querying Data @@ -50,17 +62,29 @@ Each Base in Teable corresponds to a **schema** in PostgreSQL. The BaseId is the **Method 1:** Look at the URL - the string starting with `bse` is the BaseId. -baseId +Base ID in the URL **Method 2:** In the Base Design interface, the schema name shown is the BaseId. -Design page +Schema name in the Base Design page ### Finding Table Names Table names in Teable interface don't automatically sync with physical database table names. Check the Base Design Interface for the actual database table name. -table info +Physical table name in the design page **Tip:** You can modify the physical table name in the design interface if needed. @@ -68,7 +92,11 @@ Table names in Teable interface don't automatically sync with physical database Field (column) names in the database may differ from the Teable interface. Check the `dbFieldName` in the design interface. -db field name +DB field name in the design page **Tip:** Changing field names in Teable won't sync automatically. Modify `dbFieldName` explicitly to change the actual column name in PostgreSQL. @@ -98,7 +126,11 @@ The database connection is scoped to the current base only. PostgreSQL schemas p You may see other baseIds (schema names) when connecting, but you cannot access their content. -base id in TablePlus +Base ID in TablePlus ### Connection Limits diff --git a/en/basic/admin-panel/multitenancy.mdx b/en/basic/admin-panel/multitenancy.mdx index d6dc5d49..6cd45dc5 100644 --- a/en/basic/admin-panel/multitenancy.mdx +++ b/en/basic/admin-panel/multitenancy.mdx @@ -10,7 +10,11 @@ description: "Teable supports organizations, allowing multiple organizations to Instance administrators access the organization management panel via `Admin Panel` > `Organizations` -![](/images/2025-10-14-22-14-29.png) +Organizations entry in the Admin Panel The first user registered in the instance becomes an instance administrator @@ -40,7 +44,11 @@ The organization management interface displays detailed information for all orga - **Administrator Settings**: Add or remove administrators for this organization. All users can be selected as administrators except deleted users - **Delete Organization**: The organization and its related settings will be deleted and this operation cannot be undone - proceed with caution -![](/images/2025-10-14-22-15-14.png) +Organization list in the Admin Panel ## 2. Tiered Administrator System diff --git a/en/changelog-2024.mdx b/en/changelog-2024.mdx index 4160b0da..511a7b93 100644 --- a/en/changelog-2024.mdx +++ b/en/changelog-2024.mdx @@ -15,7 +15,7 @@ We've launched a new calendar view feature that allows you to manage and view sc 3. Select "Calendar View" from the options 4. The calendar view will be added to your view list - +How to Add Calendar View screenshot ## 2. Global Search and Keyword Highlighting @@ -25,7 +25,7 @@ Search functionality has been greatly improved. You can now perform global searc * Support for global search across multiple fields * Highlighted search result keywords * Flexible search result filtering options - +Global Search and Keyword Highlighting screenshot ## 3. Lookup and Rollup Field Optimization @@ -33,7 +33,7 @@ Search functionality has been greatly improved. You can now perform global searc * Enhanced rollup calculation capabilities * Extended data analysis and processing capabilities - +Lookup and Rollup Field Optimization screenshot ## 4. Form Enhancement @@ -42,7 +42,7 @@ Search functionality has been greatly improved. You can now perform global searc * New form login requirement option * Automatic submission tracking with creator information visible in the creator field - +Login Verification screenshot ## 5. Single/Multiple Select Field Settings @@ -51,7 +51,7 @@ Users can now disable the option to add new choices when editing single or multi * Option to restrict new choice additions * Prevention of accidental invalid choice entries - +Single/Multiple Select Field Settings screenshot ## 6. Performance Optimization and Other Improvements @@ -78,9 +78,9 @@ We're excited to announce the new Gallery View feature in Teable, offering a mor 1. Click the "+" icon in the view bar 2. Select "Gallery View" from the options - +How to Add Gallery View screenshot - +How to Add Gallery View screenshot 2 ## 2. Enhanced Attachment Preview @@ -115,7 +115,7 @@ We've simplified the record duplication process with multiple shortcuts. 2. Click the "More" button in the form 3. Select "Duplicate Record" from the dropdown menu - +Method 2: Through Edit Form screenshot **Tip**: The record duplication feature helps you quickly create similar records, significantly improving data entry efficiency. @@ -128,27 +128,27 @@ We hope these new features and optimizations enhance your experience. If you hav ## 1. Dashboard - - +Dashboard screenshot +Dashboard screenshot 2 ### 1.1 Comprehensive Chart Types * Support for Bar/Line/Pie/Area/Table charts - +Comprehensive Chart Types screenshot ### 1.2 Flexible Data Queries * Support for selection/filtering/joining/sorting/grouping/aggregation query configurations - +Flexible Data Queries screenshot ## 2. Plugin View - Sheet Form - +Plugin View - Sheet Form screenshot ## 3. [Record Comments](https://help.teable.ai/basic/record/comment#key-features) - +Record Comments screenshot * Real-time conversations * @mention support @@ -158,7 +158,7 @@ We hope these new features and optimizations enhance your experience. If you hav ## 4. Group Statistics * Statistics for each group - +Group Statistics screenshot ## 5. Linked Fields @@ -170,9 +170,9 @@ We hope these new features and optimizations enhance your experience. If you hav * Select base and table * Example: Link from **Project Management** base to Product Task Management - +Cross-base Field Linking screenshot - +Cross-base Field Linking screenshot 2 ### 5.2 Filter Records from Views @@ -181,17 +181,17 @@ We hope these new features and optimizations enhance your experience. If you hav * More configurations * Select view/configure filter conditions - +Filter Records from Views screenshot ## 6. Field Default Values * Default values can be set for most field types - +Field Default Values screenshot ## 7. Kanban View Supports All Field Types for Grouping - +Kanban View Supports All Field Types for Grouping screenshot ## 8. Experience Improvements @@ -208,9 +208,9 @@ We hope these new features and optimizations enhance your experience. If you hav You can now restore deleted spaces, bases, and tables from the trash! - - - +Trash screenshot +Trash screenshot 2 +Trash screenshot 3 ## 2. Drag and Drop Attachment Order to Reorder @@ -228,7 +228,7 @@ All operations in the table can be undone and redone. You can now invite collaborators to enter the base for collaboration without entering the space. - +Base collaborator screenshot @@ -237,17 +237,17 @@ You can now invite collaborators to enter the base for collaboration without ent View the record modification history of the entire table in the upper right corner of the table. - +Record Modification History screenshot View the edit history of the current record in the upper right corner of the record edit interface. - +Record Modification History screenshot 2 ## 2. Creator and Last Modified User Fields Added two fields. Creator and last modified user fields are used to track data changes. - +Creator and Last Modified User Fields screenshot ## 3. Language/Internationalization Switch @@ -256,7 +256,7 @@ Added two fields. Creator and last modified user fields are used to track data c 2. Language 3. Please select the language you want to use. - +Language/Internationalization Switch screenshot @@ -279,9 +279,9 @@ Operation steps: 2. Toolbar display 3. Embedding code - +Share View Embedding and Custom Sharing screenshot - +Share View Embedding and Custom Sharing screenshot 2 Through the new feature, you can more flexibly control the display of shared content, improving collaboration efficiency @@ -294,7 +294,7 @@ Through the new feature, you can more flexibly control the display of shared con * **Unique Value Verification Constraint:** Added field unique value verification function to ensure that the field value is unique in the entire table. * **Non-empty Verification:** Added field non-empty verification function to prevent missing key information. - +Non-empty Verification screenshot ## 2. API Query Builder @@ -304,7 +304,7 @@ Introduced visual API query builder to greatly simplify API request building pro 2. Build query requests through intuitive user interface 3. Copy directly runnable code generated by one click - +API Query Builder screenshot ## 3. User Experience Optimization @@ -312,25 +312,25 @@ Introduced visual API query builder to greatly simplify API request building pro * Allow users to fill in complete row information before creating records to improve data completeness - +User Experience Optimization screenshot ### 3.2 Date Picker Upgrade * Date picker now supports direct selection of year and month to improve selection efficiency - +Date Picker Upgrade screenshot ### 3.3 Number Field Editing Optimization * Display unformatted original values of number fields for precise modification during editing - +Number Field Editing Optimization screenshot ### 3.4 Sharing Function Enhancement * Added QR code sharing option when sharing view link, convenient for mobile users to quickly access - +Sharing Function Enhancement screenshot ## 4. Data Import Function Enhancement diff --git a/en/changelog-2025.mdx b/en/changelog-2025.mdx index bfefabbb..993fcf30 100644 --- a/en/changelog-2025.mdx +++ b/en/changelog-2025.mdx @@ -139,15 +139,15 @@ This release brings **6 big revolutions**, rewriting how we work with data. The Button field is a powerful interactive tool that transforms static rows of data into actionable units. With a single click, users can trigger pre-configured automations to handle internal data flows—like updating a record’s status or syncing data across tables—and even perform external actions, such as sending custom notifications or calling an external API. It also supports custom labels and colors, limits on clicks and resets, and allows read-only users to trigger actions. - +Button Field screenshot - **One-Click Actions**: Effortlessly manage status changes, sync data, send notifications, and more. - +One-Click Actions screenshot - **Precise Control**: Set a "Max clicks" and a "Allow reset" for each button to prevent accidental clicks or duplicate actions. - +Precise Control screenshot @@ -155,51 +155,51 @@ The Button field is a powerful interactive tool that transforms static rows of d ## AI Features - **Base Chat System**: You can chat with your base and generate reports - +Base Chat System screenshot - **AI Field Configuration**: Comprehensive AI configuration support for attachment, numeric, and other field types with improved interaction experience - + AI Field Configuration screenshot - + AI Features screenshot ## Permission & Access Control - **Cell-level Permission Control**: Granular permission management at the cell level with enhanced authority matrix and record history permissions - +Cell-level Permission Control screenshot - **Advanced Access Management**: Full access control with hasFullAccess field and improved user validation systems - +Advanced Access Management screenshot ## Enterprise Management - **Custom Branding**: Complete custom branding solution for enterprise deployments - +Custom Branding screenshot - **Department Management**: Advanced department creation with custom IDs and enhanced member management capabilities - **Audit & Monitoring**: Comprehensive audit log functionality for tracking system activities ## Automation & Workflow - **Enhanced Automation System**: Improved automation with nested conditions, better date comparisons, and deadlock prevention in automation actions - +Enhanced Automation System screenshot - **Advanced Workflow Actions**: Enhanced HTTP actions with proper encoding, JSON parsing, and error handling - +Advanced Workflow Actions screenshot # Teable Updates (Core) ## Core Platform Features - **Base & Workspace Management**: Support for moving bases between spaces and enhanced workspace organization - +Base & Workspace Management screenshot - **Template System**: Complete template functionality with markdown descriptions, mobile UI optimization, and advanced duplication capabilities - +Template System screenshot - **Field Management**: Support for field duplication and improved field conversion with undo/redo functionality - +Field Management screenshot ## Data Management & Performance - **Enhanced Import/Export**: Optimized import queue with worker system, improved Excel handling with precision fixes, and better export functionality @@ -208,21 +208,21 @@ The Button field is a powerful interactive tool that transforms static rows of d ## User Experience Improvements - **Enhanced Editors**: Improved formula editor performance and date editor with manual input support and European format compatibility - +Enhanced Editors screenshot - **Navigation & Discovery**: Recent base list functionality and quick page navigation with last visited page memory - +Navigation & Discovery screenshot - **Mobile Experience**: Comprehensive mobile optimization across all components and interfaces - +Mobile Experience screenshot ## UI & Interaction - **Advanced Filtering**: Support for filtering by formatted date and improved filter management - +Advanced Filtering screenshot - **Copy/Paste Enhancement**: HTML parsing support for better data transfer between applications - **Multi-line Support**: Field names with multi-line support and batch collapse functionality for better organization - +Multi-line Support screenshot @@ -231,39 +231,39 @@ The Button field is a powerful interactive tool that transforms static rows of d Navigate to **Admin Panel** > **Template Admin** to create a new template. You can select a base from any space, customize it with a cover image, and add a detailed description. - +Template Management screenshot Users can create new bases from any available template. - +Template Management screenshot 2 - +Template Management screenshot 3 ## Base Import/Export Export your base to a `.tea` file (which can be extracted as a ZIP archive) - +Base Import/Export screenshot Import an existing base from a `.tea` file - +Base Import/Export screenshot 2 - +Base Import/Export screenshot 3 ## Field Duplication Easily duplicate any field with a single click - +Field Duplication screenshot ## Custom LLM Integration Support - You can custom LLM integration in space setting - +Custom LLM Integration Support screenshot ## Table Duplication - Support for duplicating tables, including proper handling of linked fields and relationships - +Table Duplication screenshot ## Quick navigation - Added memory of last visited page for quick navigation @@ -276,13 +276,13 @@ Easily duplicate any field with a single click "description": "Added memory of last visited page for quick navigation.", "thumbnailUrl": ["https://teable.ai/assets/images/og-image.png"], "uploadDate": "2025-03-21T00:00:00+08:00", - "contentUrl": "https://help.teable.ai/images/425306571-60138722-a683-4133-a021-e492dc3538e7.mp4" + "contentUrl": "https://help.teable.ai/images/changelog/2025/425306571-60138722-a683-4133-a021-e492dc3538e7.mp4" }) }} /> @@ -158,45 +158,45 @@ AI数据库Agent带来6大创新，彻底改变你用数据的方式： ## AI 功能 - **AI 对话**：可与数据库对话并生成报表 - +AI 对话截图 - **AI 字段配置**：全面支持附件、数值等字段类型的 AI 配置，交互体验提升 - + AI 字段配置截图 - + AI 功能截图 ## 权限与访问控制 - **单元格级权限控制**：实现更细粒度的单元格级权限管理，增强权限矩阵和记录历史权限 - +单元格级权限控制截图 - **高级访问管理**：hasFullAccess 字段实现完整访问控制，用户校验系统优化 - +高级访问管理截图 ## 企业管理 - **自定义品牌**：为企业部署提供完整的品牌定制方案 - +自定义品牌截图 - **部门管理**：支持自定义 ID 的高级部门创建及成员管理能力提升 - **审计与监控**：完善的审计日志功能，便于追踪系统活动 ## 自动化与流程 - **自动化系统增强**：支持嵌套条件、日期比较优化、自动化动作死锁预防 - +自动化系统增强截图 - **高级流程动作**：HTTP 动作支持编码、JSON 解析与错误处理能力提升 - +高级流程动作截图 # Teable 更新（社区版） ## 核心平台功能 - **数据库与空间管理**：支持数据库在空间间移动，空间组织能力增强 - +数据库与空间管理截图 - **模板系统**：完善的模板功能，支持 markdown 描述、移动端 UI 优化及高级复制 - +模板系统截图 - **字段管理**：支持字段复制，字段类型转换支持撤销/重做 - +字段管理截图 ## 数据管理与性能 - **导入/导出增强**：导入队列优化为工作线程，Excel 处理精度提升，导出功能优化 @@ -205,18 +205,18 @@ AI数据库Agent带来6大创新，彻底改变你用数据的方式： ## 用户体验提升 - **编辑器优化**：公式编辑器性能提升，日期编辑器支持手动输入及欧洲格式 - +编辑器优化截图 - **导航与发现**：最近数据库列表、快速页面导航并记忆上次访问页面 - +导航与发现截图 - **移动端体验**：全组件与界面移动端适配优化 - +移动端体验截图 ## 界面与交互 - **高级筛选**：支持按格式化日期筛选，筛选管理优化 - +高级筛选截图 - **复制粘贴增强**：支持 HTML 解析，提升跨应用数据传输体验 - **多行支持**：字段名支持多行显示，批量折叠功能提升组织性 - +多行支持截图 @@ -224,39 +224,39 @@ AI数据库Agent带来6大创新，彻底改变你用数据的方式： 导航到 **管理员面板** > **模板管理** 创建一个新模板。 您可以从任何空间选择一个数据库，使用封面图片和详细描述进行自定义。 - +模板管理截图 用户可以从任何可用的模板创建新的数据库。 - +模板管理截图 2 - +模板管理截图 3 ## 数据库导入/导出 将您的数据库导出为 `.tea` 文件（可以使用 ZIP 解压） - +数据库导入/导出截图 从 `.tea` 文件导入现有数据库 - +数据库导入/导出截图 2 - +数据库导入/导出截图 3 ## 字段复制 轻松点击复制任何字段 - +字段复制截图 ## 自定义大语言模型集成 - 现在可以在空间设置中自定义大语言模型集成 - +自定义大语言模型集成截图 ## 表格复制功能 - 支持复制表格，包括正确处理关联字段和关系 - +表格复制功能截图 ## 快速导航 @@ -269,13 +269,13 @@ AI数据库Agent带来6大创新，彻底改变你用数据的方式： "description": "添加了最近访问页面的记忆功能，方便快速导航。", "thumbnailUrl": ["https://teable.ai/assets/images/og-image.png"], "uploadDate": "2025-03-21T00:00:00+08:00", - "contentUrl": "https://help.teable.cn/images/425306571-60138722-a683-4133-a021-e492dc3538e7.mp4" + "contentUrl": "https://help.teable.cn/images/changelog/2025/425306571-60138722-a683-4133-a021-e492dc3538e7.mp4" }) }} />