π― Repository Overview
This repository contains the complete documentation for Ona (formerly Gitpod), including:- Ona - The new cloud development environment platform
- Gitpod Classic - Legacy documentation for the original Gitpod platform
- Examples - AI agent use cases and getting started examples
- Release Notes - Product updates and changelog
π Repository Structure
πΌοΈ Image Management Guidelines
Standard Assets (< 20MB)
- Location:
/images/
directory - Path in MDX:
/images/filename.ext
- Supported formats: PNG, JPG, JPEG, WebP, SVG, GIF, WebM, MP4
Large Assets (β₯ 20MB)
- Repository:
gitpod-io/ona.com
- Directory:
public/docs-large-assets/
- Path in MDX:
https://www.ona.com/docs-large-assets/filename.ext
Migration Status
β All existing images moved to/images/
directoryβ All MDX references updated automatically
β No broken links or missing assets
π οΈ Development Workflow
Getting Started
Making Changes
- Create/edit MDX files in the appropriate directory (
ona/
,classic/
,examples/
) - Add images to
/images/
directory (or large assets repo if >20MB) - Update
docs.json
for navigation changes - Test locally with
mintlify dev
- Commit and push to
main
branch
File Locations
- Ona docs:
/workspaces/docs/ona/
- Classic docs:
/workspaces/docs/classic/
- Examples:
/workspaces/docs/examples/
- Images:
/workspaces/docs/images/
- Configuration:
/workspaces/docs/docs.json
π Documentation Standards
Image References
File Naming
- Use kebab-case for files:
getting-started.mdx
- Use descriptive names for images:
vscode-integration-screenshot.png
- Avoid spaces and special characters
π Handling Redirects
Redirects are managed in the Mintlify configuration file:- File:
/workspaces/docs/docs.json
- Purpose: Handle URL redirects and navigation
- Format: JSON configuration with redirect rules
- Updates: Modify this file when changing page URLs or adding redirects
π Deployment
- Automatic deployment on push to
main
branch - Live site: ona.com/docs
- Preview: Available via Mintlifyβs preview system
β Support Information
- Repository:
gitpod-io/docs
- Issues: Use GitHub issues in the docs repo
- Mintlify docs: mintlify.com/docs
- Team contact:
#team-website
Slack channel