Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

Reorganized the documentation navigation structure for better discoverability and combined related settings into a single page.

Changes

  • Navigation restructuring:

    • Created new top-level "General" group under Database CI/CD tab
    • Moved settings-related pages from UI-Driven Workflow to General group
    • Moved schema-template to Change group where it logically belongs
  • Content consolidation:

    • Combined issue.mdx and transaction-mode.mdx into single settings.mdx file
    • Simplified and clarified content for better readability
    • Removed unnecessary screenshots

Benefits

  • Settings are now more discoverable at the top level
  • Related configuration options are grouped together
  • Cleaner navigation structure with logical grouping
  • Improved content clarity and conciseness

🤖 Generated with Claude Code

- Moved Settings group from UI-Driven Workflow to top-level "General" group
- Combined issue.mdx and transaction-mode.mdx into single settings.mdx file
- Moved schema-template to Change group under UI-Driven Workflow
- Simplified and clarified content in settings page
- Removed unnecessary screenshots

This improves navigation structure and makes settings more discoverable.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copilot AI review requested due to automatic review settings August 29, 2025 05:59
@vercel
Copy link

vercel bot commented Aug 29, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Ready Preview Comment Aug 29, 2025 6:07am

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reorganizes the documentation navigation structure for better discoverability by moving settings-related pages to a new top-level "General" group and consolidating related content into a single settings file.

  • Moved schema-template from Settings group to Change group for logical grouping
  • Created new "General" group under Database CI/CD tab for better settings discoverability
  • Combined issue.mdx and transaction-mode.mdx into a consolidated settings.mdx file

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
mintlify/docs.json Updates navigation structure by moving schema-template, removing old Settings group, and adding new General group
mintlify/change-database/transaction-mode.mdx Removes standalone transaction mode documentation (content moved to settings.mdx)
mintlify/change-database/settings.mdx Creates new consolidated settings page combining transaction mode, Postgres tenant mode, and self approval content
mintlify/change-database/issue.mdx Removes standalone issue documentation (content moved to settings.mdx)

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions
Copy link

github-actions bot commented Aug 29, 2025

📝 Broken Links Check Report

Note: Entries under /api-reference/ are likely false positives and can be ignored.

The following is the output from the broken links check:

found 16 broken links in 9 files

integrations/api/audit-log.mdx
 ⎿  /api-reference/auditlogservice/post-v1auditlogs:search

integrations/api/authentication.mdx
 ⎿  /api-reference/authservice/post-v1authlogin

integrations/api/data-classification.mdx
 ⎿  /api-reference/settingservice/patch-v1settings
 ⎿  /api-reference/databaseservice/patch-v1instances-databases

integrations/api/issue.mdx
 ⎿  /api-reference/issueservice/post-v1projects-issues

integrations/api/permission.mdx
 ⎿  /api-reference/workspaceservice/get-v1workspaces-:getIamPolicy
 ⎿  /api-reference/projectservice/get-v1projects-:getIamPolicy
 ⎿  /api-reference/roleservice/get-v1roles
 ⎿  /api-reference/userservice/get-v1users
 ⎿  /api-reference/groupservice/get-v1groups

integrations/api/plan.mdx
 ⎿  /api-reference/planservice/post-v1projects-plans
 ⎿  /api-reference/sheetservice/post-v1projects-sheets

integrations/api/release.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases

integrations/api/rollout.mdx
 ⎿  /api-reference/rolloutservice/post-v1projects-rollouts

integrations/api/sql-review.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases:check
 ⎿  /api-reference/sqlservice/post-v1sqlcheck

@tianzhou
Copy link
Member

administration/custom-approval.mdx
⎿ /change-database/issue/#self-approval

change-database/troubleshoot.mdx
⎿ /change-database/issue/#postgres-database-tenant-mode
⎿ /change-database/issue/#postgres-database-tenant-mode

These links are broken. We can run mint broken-links (ignore the /api-reference/ due to mintlify bug)

- Update link in custom-approval.mdx from /change-database/issue/#self-approval to /change-database/settings#self-approval
- Update links in troubleshoot.mdx from /change-database/issue/#postgres-database-tenant-mode to /change-database/settings#postgres-tenant-mode

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link
Member

@tianzhou tianzhou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tianzhou tianzhou merged commit adddc60 into main Aug 29, 2025
5 checks passed
@tianzhou tianzhou deleted the refactor/reorganize-change-database-settings branch August 29, 2025 06:15
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.

4 participants