Skip to content

Commit e38d931

Browse files
d-bytebaseclaude
andauthored
docs: consolidate error code documentation into SQL Review section (#875)
* docs: consolidate error code documentation into SQL Review section Moved all error code references from /reference/error-code to /sql-review/error-codes.mdx for better organization and discoverability. This consolidates advisor and core error codes into a single location within the SQL Review documentation where they are most relevant to users. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * docs: add redirects for old error code pages Added redirects from the old error code documentation paths to the new consolidated location at /sql-review/error-codes to ensure existing links and bookmarks continue to work. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent 59c96b0 commit e38d931

File tree

5 files changed

+13
-65
lines changed

5 files changed

+13
-65
lines changed

mintlify/changelog/bytebase-0-7-0.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ We currently detect following anomalies and will add more in the future:
3535

3636
### Backward compatible schema migration check (MySQL/TiDB)
3737

38-
In the last release, we introduce the task check system and introduced the basic SQL syntax check. In this release, we advance the check to catch backward incompatible schema migration (e.g. RENAME TABLE). Introducing backward incompatible schema changes is one of the most common mistakes made by developers and enforcing backward compatible schema change is the standard practice adopted by many engineering organizations. Bytebase now automatically checks all common incompatible schema change [scenarios](https://www.bytebase.com/docs/reference/error-code/advisor/#compatibility) and surface them in the SQL review panel:
38+
In the last release, we introduce the task check system and introduced the basic SQL syntax check. In this release, we advance the check to catch backward incompatible schema migration (e.g. RENAME TABLE). Introducing backward incompatible schema changes is one of the most common mistakes made by developers and enforcing backward compatible schema change is the standard practice adopted by many engineering organizations. Bytebase now automatically checks all common incompatible schema change [scenarios](https://www.bytebase.com/docs/sql-review/error-codes/#compatibility) and surface them in the SQL review panel:
3939
![_](/content/changelog/0.7.0/backward-compatible-check.webp)
4040

4141
### Backup schedule enforcement

mintlify/docs.json

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,8 @@
135135
{
136136
"group": "Appendix",
137137
"pages": [
138-
"sql-review/review-rules"
138+
"sql-review/review-rules",
139+
"sql-review/error-codes"
139140
]
140141
}
141142
]
@@ -225,13 +226,6 @@
225226
"administration/announcement",
226227
"administration/archive"
227228
]
228-
},
229-
{
230-
"group": "Reference",
231-
"pages": [
232-
"reference/error-code/core",
233-
"reference/error-code/advisor"
234-
]
235229
}
236230
]
237231
},
@@ -491,6 +485,14 @@
491485
}
492486
},
493487
"redirects": [
488+
{
489+
"source": "/reference/error-code/advisor",
490+
"destination": "/sql-review/error-codes"
491+
},
492+
{
493+
"source": "/reference/error-code/core",
494+
"destination": "/sql-review/error-codes"
495+
},
494496
{
495497
"source": "/get-started/instance",
496498
"destination": "/get-started/connect/overview"

mintlify/reference/error-code/core.mdx

Lines changed: 0 additions & 54 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Error Code for SQL Review
2+
title: Error Codes
33
---
44

55
## General

mintlify/sql-review/review-rules.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -861,7 +861,7 @@ Specifically, Bytebase checks:
861861
<div id="schema.backward-compatibility"></div>
862862
### Backward incompatible schema change
863863

864-
Introducing backward incompatible schema changes is one of the most common mistakes made by developers. And enforcing backward compatible schema change is the standard practice adopted by many engineering organizations. Bytebase provides the built-in backward compatible check to catch all common incompatible schema change [scenarios](https://www.bytebase.com/docs/reference/error-code/advisor/#compatibility).
864+
Introducing backward incompatible schema changes is one of the most common mistakes made by developers. And enforcing backward compatible schema change is the standard practice adopted by many engineering organizations. Bytebase provides the built-in backward compatible check to catch all common incompatible schema change [scenarios](https://www.bytebase.com/docs/sql-review/error-codes/#compatibility).
865865

866866
![schema-review-schema-backward-compatibility](/content/docs/sql-review/schema-review-schema-backward-compatibility.webp)
867867

0 commit comments

Comments
 (0)