Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

  • Moved System Requirements section from FAQ page to Production Setup documentation for better organization
  • Updated all documentation links to point to the new location
  • Improved readability of the Storage section with clearer guidance

Changes

  • Removed System Requirements section from /mintlify/faq.mdx
  • Added System Requirements to /mintlify/get-started/self-host/production-setup.mdx
  • Updated links in:
    • /mintlify/get-started/self-host/deploy-with-docker.mdx
    • /mintlify/get-started/self-host/deploy-with-kubernetes.mdx
    • /mintlify/onboarding/poc.mdx
  • Simplified Storage section with specific guidance for cloud vs fixed storage scenarios

🤖 Generated with Claude Code

- Moved System Requirements section from FAQ to Production Setup page
- Updated all links across documentation to point to new location
- Simplified Storage section with clearer guidance on disk sizing
- Removed redundant "Resources" subsection

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

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

vercel bot commented Aug 11, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bytebase-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 11, 2025 5:24am

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 documentation by moving system requirements from the FAQ section to the Production Setup guide for improved discoverability and logical grouping.

  • Relocated System Requirements section from FAQ to Production Setup documentation
  • Updated all cross-references to point to the new location
  • Enhanced the Storage section with clearer, scenario-specific guidance

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
mintlify/faq.mdx Removed System Requirements section
mintlify/get-started/self-host/production-setup.mdx Added System Requirements section with improved Storage guidance
mintlify/onboarding/poc.mdx Updated System Requirements link reference
mintlify/get-started/self-host/deploy-with-kubernetes.mdx Updated System Requirements link reference
mintlify/get-started/self-host/deploy-with-docker.mdx Updated System Requirements link reference

@github-actions
Copy link

📝 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

@d-bytebase d-bytebase changed the title Move System Requirements from FAQ to Production Setup docs: move System Requirements from FAQ to Production Setup Aug 11, 2025
@tianzhou
Copy link
Member

LGTM

@tianzhou tianzhou merged commit e696d2e into main Aug 11, 2025
4 of 5 checks passed
@tianzhou tianzhou deleted the move-system-requirements branch August 11, 2025 05:31
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.

3 participants