Skip to content

Commit 2f25a79

Browse files
authored
chore: reorganize docs image assets
Reorganize docs image assets, standardize image markup, move unreferenced assets to orphans, and document image asset conventions.
1 parent 45f3044 commit 2f25a79

418 files changed

Lines changed: 484 additions & 209 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,73 @@ mintlify dev
1919
Use the [Paste Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image) extension to paste images into the markdown file.
2020
Open mdx file and press `cmd + option + v` to paste image.
2121

22+
### Image Assets
23+
24+
Images are shared repo assets. Keep paths stable, names searchable, and
25+
rendering consistent.
26+
27+
When a change includes images, ask the agent to read this section first and
28+
commit only images processed according to these rules.
29+
30+
#### Folder Rules
31+
32+
- Use `images/{top-level-group}/{topic}/`.
33+
- Top-level groups: `docs`, `selfhosted`, `api`, `security`, `changelog`.
34+
- `docs` maps to the Help Center Docs tab. Do not flatten
35+
`images/docs/{topic}/` into `images/{topic}/`.
36+
- `{topic}` maps to the navigation name in `docs.json`, such as `ai`, `base`,
37+
`space`, `sso`, `authority-matrix`, `get-id`, `sql-query`, or `activate`.
38+
- Do not put new screenshots in the `images/` root.
39+
- Do not commit random staging folders.
40+
- Put unreferenced images in `images/orphans/YYYY-MM-DD/...` first. Do not
41+
delete them directly.
42+
- Docs pages must not reference `images/orphans/...`.
43+
44+
#### Naming
45+
46+
Use this format:
47+
48+
```text
49+
images/{top-level-group}/{topic}/YYYY-MM-DD-page-slug-purpose.png
50+
images/{top-level-group}/{topic}/YYYY-MM-DD-page-slug-purpose.webp
51+
images/{top-level-group}/{topic}/YYYY-MM-DD-page-slug-purpose-zh.png
52+
```
53+
54+
- Date = day the image enters the docs repo.
55+
- Page slug = docs page or feature area.
56+
- Purpose = visible UI or action. Do not use `image1` or random hashes.
57+
- Use `.png` for static UI screenshots.
58+
- Prefer `.webp` for animated screenshots.
59+
- English-only screenshot = shared asset. Do not add `-en`.
60+
- Chinese-specific screenshot = add `-zh`.
61+
62+
#### Image Handling
63+
64+
- Logos, inline icons, external button images, videos, and historical changelog
65+
media do not need screenshot styling.
66+
67+
#### MDX Usage
68+
69+
Use explicit `<img>` for docs screenshots:
70+
71+
```mdx
72+
<img
73+
src="/images/docs/ai/YYYY-MM-DD-page-slug-purpose.png"
74+
alt="AI Chat context selector"
75+
className="docs-screenshot"
76+
/>
77+
```
78+
79+
- Use `className="docs-screenshot"` for new PNG/WebP docs screenshots under
80+
`images/docs/`, `images/api/`, `images/selfhosted/`, and `images/security/`.
81+
- Alt text must be non-empty.
82+
- Alt text describes the visible UI or action. Do not use `screenshot` or the
83+
file name.
84+
- Do not use `![](...)` for new docs screenshots.
85+
- Avoid `width="400"`, percentage widths, and one-off image sizing.
86+
- Changelog images keep their historical display. Add useful alt text when
87+
context exists. Do not add `docs-screenshot` blindly.
88+
2289
### Publishing Changes
2390

2491
Push to origin main branch, the changes will be deployed to production automatically.

en/api-doc/get-id.mdx

Lines changed: 45 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,47 +6,83 @@ title: "Getting IDs"
66

77
Click on the target space and copy the string starting with 'spc' from the URL, example: `spcXXXXXXXXXX`
88

9-
![](/images/2026-02-12-10-43-08.png)
9+
<img
10+
src="/images/api/get-id/2026-05-29-get-id-space-id.png"
11+
alt="Space ID in the URL"
12+
className="docs-screenshot"
13+
/>
1014

1115
## BaseId
1216

1317
Click on the target base and copy the string starting with 'bse' from the URL, example: `bseXXXXXXXXXX`
1418

15-
![](/images/2026-02-12-10-46-49.png)
19+
<img
20+
src="/images/api/get-id/2026-05-29-get-id-base-id.png"
21+
alt="Base ID in the URL"
22+
className="docs-screenshot"
23+
/>
1624

1725
## TableId
1826

1927
Click on the target table and copy the string starting with 'tbl' from the URL, example: `tblXXXXXXXXXX`
2028

21-
![](/images/2026-02-12-10-48-18.png)
29+
<img
30+
src="/images/api/get-id/2026-05-29-get-id-table-id.png"
31+
alt="Table ID in the URL"
32+
className="docs-screenshot"
33+
/>
2234

2335
## ViewId
2436

2537
Click on the target view and copy the string starting with 'viw' from the URL, example: `viwXXXXXXXXXX`
2638

27-
![](/images/2026-02-12-10-48-11.png)
39+
<img
40+
src="/images/api/get-id/2026-05-29-get-id-view-id.png"
41+
alt="View ID in the URL"
42+
className="docs-screenshot"
43+
/>
2844

2945
## FieldId
3046

3147
**Method 1:**
3248

3349
Click the "More" icon (three dots) in the top left corner, then select "Design" to enter the design interface and view all field IDs
3450

35-
<img src="/images/2026-02-12-10-50-30.png" width="400" />
51+
<img
52+
src="/images/api/get-id/2026-05-29-get-id-field-id-design-entry-en.png"
53+
alt="Open the design page from the More menu"
54+
className="docs-screenshot"
55+
/>
3656

37-
![](/images/2025-02-14-18-16-26.png)
57+
<img
58+
src="/images/api/get-id/2026-05-29-get-id-field-id-design-list.png"
59+
alt="Field IDs in the design page"
60+
className="docs-screenshot"
61+
/>
3862

3963
**Method 2:**
4064

4165
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.
4266

43-
<img src="/images/2026-02-12-10-59-21.png" width="400" />
67+
<img
68+
src="/images/api/get-id/2026-05-29-get-id-field-id-edit-field-entry-en.png"
69+
alt="Open field settings from the column menu"
70+
className="docs-screenshot"
71+
/>
4472

45-
<img src="/images/2026-02-12-11-00-16.png" width="400" />
73+
<img
74+
src="/images/api/get-id/2026-05-29-get-id-field-id-db-field-name-en.png"
75+
alt="DB field name with the field ID"
76+
className="docs-screenshot"
77+
/>
4678

4779

4880
## RecordId
4981

5082
Expand the record edit form and copy the string starting with 'rec' after 'recordId=' in the URL, example: `recXXXXXXXXXX`
5183

52-
![](/images/2026-02-12-10-55-17.png)
84+
<img
85+
src="/images/api/get-id/2026-05-29-get-id-record-id.png"
86+
alt="Record ID in the expanded record URL"
87+
className="docs-screenshot"
88+
/>

en/api-doc/sql-query.mdx

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,30 @@ Teable allows you to connect to its underlying PostgreSQL database through exter
1414
1. **Open a Table**: First, open any table within the base you want to connect to.
1515
2. **Enter Design Page**: Click the ⚙️ icon in the top right corner to enter the Base Design page.
1616

17-
![](/images/2025-12-05-01-16-08.png)
17+
<img
18+
src="/images/api/sql-query/2026-05-29-sql-query-open-design-page-en.png"
19+
alt="Open the Base Design page"
20+
className="docs-screenshot"
21+
/>
1822

1923
3. **Find Database Connection Panel**: In the Design page, locate the "Database Connection" panel.
2024
4. **Create Connection**: Click create, and the system will automatically generate a read-only PostgreSQL connection with username, password, and host address.
2125

22-
![](/images/2025-12-05-01-17-53.png)
26+
<img
27+
src="/images/api/sql-query/2026-05-29-sql-query-database-connection-panel-en.png"
28+
alt="Database Connection panel"
29+
className="docs-screenshot"
30+
/>
2331

2432
### Connecting to the Database
2533

2634
Use the credentials to connect through your preferred tool. Here's an example:
2735

28-
<img alt="Connection example" src="/images/kai-fa-zhe/ceef01dd644628f4.png" />
36+
<img
37+
src="/images/api/sql-query/2026-05-29-sql-query-connection-example.png"
38+
alt="External database connection example"
39+
className="docs-screenshot"
40+
/>
2941

3042
### Querying Data
3143

@@ -50,25 +62,41 @@ Each Base in Teable corresponds to a **schema** in PostgreSQL. The BaseId is the
5062

5163
**Method 1:** Look at the URL - the string starting with `bse` is the BaseId.
5264

53-
<img alt="baseId" src="/images/kai-fa-zhe/e8ef17c59ac0c067.png" />
65+
<img
66+
src="/images/api/sql-query/2026-05-29-sql-query-base-id-url.png"
67+
alt="Base ID in the URL"
68+
className="docs-screenshot"
69+
/>
5470

5571
**Method 2:** In the Base Design interface, the schema name shown is the BaseId.
5672

57-
<img alt="Design page" src="/images/kai-fa-zhe/64fbddbd0f5519c4.png" />
73+
<img
74+
src="/images/api/sql-query/2026-05-29-sql-query-design-page-schema.png"
75+
alt="Schema name in the Base Design page"
76+
className="docs-screenshot"
77+
/>
5878

5979
### Finding Table Names
6080

6181
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.
6282

63-
<img alt="table info" src="/images/kai-fa-zhe/ba2fdb846b2062ce.png" />
83+
<img
84+
src="/images/api/sql-query/2026-05-29-sql-query-table-info.png"
85+
alt="Physical table name in the design page"
86+
className="docs-screenshot"
87+
/>
6488

6589
**Tip:** You can modify the physical table name in the design interface if needed.
6690

6791
### Finding Field Names
6892

6993
Field (column) names in the database may differ from the Teable interface. Check the `dbFieldName` in the design interface.
7094

71-
<img alt="db field name" src="/images/kai-fa-zhe/7609033391e8e7c1.png" />
95+
<img
96+
src="/images/api/sql-query/2026-05-29-sql-query-db-field-name.png"
97+
alt="DB field name in the design page"
98+
className="docs-screenshot"
99+
/>
72100

73101
**Tip:** Changing field names in Teable won't sync automatically. Modify `dbFieldName` explicitly to change the actual column name in PostgreSQL.
74102

@@ -98,7 +126,11 @@ The database connection is scoped to the current base only. PostgreSQL schemas p
98126

99127
You may see other baseIds (schema names) when connecting, but you cannot access their content.
100128

101-
<img alt="base id in TablePlus" src="/images/kai-fa-zhe/093aebb4bc8cf732.png" />
129+
<img
130+
src="/images/api/sql-query/2026-05-29-sql-query-tableplus-base-id.png"
131+
alt="Base ID in TablePlus"
132+
className="docs-screenshot"
133+
/>
102134

103135
### Connection Limits
104136

en/basic/admin-panel/multitenancy.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@ description: "Teable supports organizations, allowing multiple organizations to
1010

1111
Instance administrators access the organization management panel via `Admin Panel` > `Organizations`
1212

13-
![](/images/2025-10-14-22-14-29.png)
13+
<img
14+
src="/images/selfhosted/admin-panel/2026-05-29-admin-panel-organizations-entry-en.png"
15+
alt="Organizations entry in the Admin Panel"
16+
className="docs-screenshot"
17+
/>
1418

1519
<Tip>The first user registered in the instance becomes an instance administrator</Tip>
1620

@@ -40,7 +44,11 @@ The organization management interface displays detailed information for all orga
4044
- **Administrator Settings**: Add or remove administrators for this organization. All users can be selected as administrators except deleted users
4145
- **Delete Organization**: The organization and its related settings will be deleted and this operation cannot be undone - proceed with caution
4246

43-
![](/images/2025-10-14-22-15-14.png)
47+
<img
48+
src="/images/selfhosted/admin-panel/2026-05-29-admin-panel-organizations-list-en.png"
49+
alt="Organization list in the Admin Panel"
50+
className="docs-screenshot"
51+
/>
4452

4553
## 2. Tiered Administrator System
4654

0 commit comments

Comments
 (0)