oceanbase-formatting
OceanBase Documentation Formatting
This skill ensures all OceanBase documentation follows consistent formatting standards and markdown lint rules.
Meta information format
Always use table format, NOT YAML frontmatter:
| Description | |
|---|---|
| description | 文档的内容描述。注意:句尾需要统一加句号。 |
| keywords | 关键词,多个关键词之间用英文逗号隔开 |
| dir-name | 这里填写希望在国内站文档中心目录上展示的名称 |
| dir-name-en | 这里填写希望在海外站文档中心目录上展示的名称 |
| tenant-type | MySQL Mode 或 Oracle Mode(两种模式均适用则不填写) |
| ddl-type | Online DDL 或 Offline DDL(仅适用于内核 SQL 语句相关文档) |
| machine-translation | 标识机器翻译的文档(如有) |
Important:
More from amber-moe/oceanbase-doc-skills
oceanbase-sql-optimization
SQL optimization best practices for OceanBase database (MySQL & Oracle modes). Covers query optimization, index usage, execution plan analysis, slow query tuning, and performance optimization techniques. Activates for SQL optimization, query performance, index design, execution plan, slow query, database performance.
24oceanbase-sql-doc
Write and format OceanBase database SQL statement documentation following official style guidelines. Use when creating or editing SQL reference documentation for OceanBase database.
17oceanbase-examples
Create SQL examples for OceanBase documentation with proper formatting, meaningful names, and separated results. Use when writing or reviewing example sections in OceanBase documentation.
16oceanbase-syntax
Write SQL syntax definitions for OceanBase documentation. Syntax sections define structure without semicolons, while examples show executable statements. Use when writing syntax sections or reviewing SQL statement documentation.
15oceanbase-schema-design
Schema design best practices for OceanBase database (MySQL & Oracle modes). Covers table design, partitioning strategies, table groups, index design, and schema optimization principles. Activates for schema design, table design, partition design, index design, database design, DDL.
13