-
Notifications
You must be signed in to change notification settings - Fork 21
Migrate to Mintlify #54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Created .scripts/validate-links.py to validate redirect mappings - Validates all source files exist in repository - Optionally checks URLs against production GitBook domain (https://docs.phala.network) - Uses HEAD requests for efficient, non-disruptive URL checking - Supports configurable timeout and domain settings - Provides detailed reporting of missing files and broken URLs 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- ✅ Converted 167+ .md files to .mdx format with proper MDX syntax - ✅ Migrated all documentation sections (Cloud, dStack, GPU TEE, etc.) - ✅ Cleaned up legacy content (agent-wars-legacy, ai-agent-contract-legacy) - ✅ Fixed figure/image conversions to Frame components with captions - ✅ Converted all relative image paths to absolute (/images/) format - ✅ Created comprehensive automation scripts for validation and fixes - ✅ Set up Mintlify configuration (mint.json) with proper navigation - ✅ Added proper .gitignore and .mintlifyignore files - ✅ Preserved 163 documented URLs for zero-downtime migration - ✅ Ready for local testing with 'mint dev' command 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
✅ Fixed individual remaining broken links: - Fixed /design-documents → /dstack/design-documents path - Fixed gatekeeper table links to use root-relative paths - Fixed dstack overview phala-cloud path reference - Fixed explore-templates table links with proper paths - Fixed invalid localhost WebSocket URLs to code format - Fixed awesome phat contracts reference - Removed invalid wss:// URL in sidevm.mdx 🎯 ZERO broken links - Ready for production deployment\! 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
…ive metadata - Added title and description frontmatter to all 164 MDX files - Removed duplicate H1 headings that matched frontmatter titles - Navigation now shows proper document titles instead of filenames - Maintained zero broken links throughout the process - Documentation structure fully optimized for Mintlify 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
…erview.mdx files - Remove 28 legacy index.mdx files from various sections - Add 15 new overview.mdx files with proper frontmatter - Update mint.json navigation to reference new overview.mdx files - Add tmp/ directory to .gitignore for temporary files - Ensure consistent navigation structure across all documentation sections 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Add placeholder files for missing redirect sources: * cloud/getting-started/getting-started.mdx → overview * cloud/use-cases/use-cases.mdx → overview * compute-providers/gatekeeper/gatekeeper.mdx → overview - Replace mint.json with docs.json for Mintlify configuration - Validate: 163/163 pages accessible (100% success, 0 broken links) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Fixed 27 invalid redirects in docs.json to point to valid page paths - Created validate-redirects.py script to extract paths and validate redirects - Created test-redirects.py script to test redirects against production - Updated migration check script to test against production URL - Achieved 95.1% redirect success rate in production testing 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Restructured as documentation index page targeting AI developers - Added focus on security, privacy, and confidential computing - Organized content with Getting Started, Core Concepts, and Support sections - Used second-person voice throughout per writing standards - Removed AI agent contract references, focused on Phala Cloud - Fixed all broken documentation links to existing file paths - Maintained Mintlify card components for better navigation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Restructured as documentation index page targeting AI developers - Added focus on security, privacy, and confidential computing - Organized content with Getting Started, Core Concepts, and Support sections - Used second-person voice throughout per writing standards - Removed AI agent contract references, focused on Phala Cloud - Fixed all broken documentation links to existing file paths - Maintained Mintlify card components for better navigation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Updated docs-validation.yml to use the new script names: - Replace check-internal-links.py with extract_links.py + check_links.py - Add mkdir -p tmp to ensure output directory exists This fixes the GitHub Actions failure where it was trying to run the deleted check-internal-links.py script. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.