diff --git a/docs/deployment.md b/docs/deployment.md deleted file mode 100644 index 07c451b..0000000 --- a/docs/deployment.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 99 -title: Deployment ---- - -# Deployment Process - -This documentation site is automatically deployed to Google Cloud Run whenever changes are pushed to the main branch. This document outlines the deployment process and how to make changes to it. - -## Automated Deployment - -The documentation site uses GitHub Actions for continuous integration and deployment (CI/CD): - -1. When changes are pushed to the `main` branch, a GitHub workflow is triggered -2. The workflow builds the Docusaurus site and packages it in a Docker container -3. The container is pushed to Google Container Registry -4. The container is deployed to Google Cloud Run -5. The site is accessible at the Cloud Run URL (with custom domain mapping) - -## Deployment Infrastructure - -The deployment infrastructure consists of: - -- **Docker Container**: The site is packaged in a Docker container for consistent deployment -- **Google Container Registry**: Stores the Docker images -- **Google Cloud Run**: Hosts the documentation site -- **GitHub Actions**: Automates the build and deployment process - -## Local Development and Testing - -To test the deployment locally: - -1. Build the Docker image: - ```bash - docker build -t mycoder-docs . - ``` - -2. Run the container locally: - ```bash - docker run -p 8080:8080 mycoder-docs - ``` - -3. Access the site at http://localhost:8080 - -## Manual Deployment - -While the deployment is automated, you can also trigger a manual deployment: - -1. Go to the GitHub repository -2. Navigate to Actions → Deploy Documentation to Cloud Run workflow -3. Click "Run workflow" and select the branch to deploy - -## Troubleshooting - -If you encounter issues with the deployment: - -1. Check the GitHub Actions logs for any errors -2. Verify that the Docker container builds successfully locally -3. Ensure the Google Cloud service account has the necessary permissions -4. Check the Cloud Run logs for runtime errors - -## Modifying the Deployment Process - -To modify the deployment process: - -1. Update the `.github/workflows/deploy-docs.yml` file for changes to the CI/CD pipeline -2. Update the `Dockerfile` for changes to the container configuration -3. Test changes locally before pushing to the repository \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started/index.mdx similarity index 88% rename from docs/getting-started.md rename to docs/getting-started/index.mdx index 47fb8bd..6b719a7 100644 --- a/docs/getting-started.md +++ b/docs/getting-started/index.mdx @@ -4,7 +4,8 @@ sidebar_position: 2 # Getting Started -Learn how to install and set up MyCoder for your development environment. +Learn how to install and set up MyCoder for your development environment.= + ## Prerequisites @@ -26,9 +27,9 @@ npx mycoder MyCoder works on all major operating systems. Select your platform for specific setup instructions: -- [Windows Setup](./getting-started/windows.md) -- [macOS Setup](./getting-started/macos.md) -- [Linux Setup](./getting-started/linux.md) +- [Windows Setup](./windows) +- [macOS Setup](./macos) +- [Linux Setup](./linux) ## Setting Up Your API Key @@ -80,6 +81,6 @@ mycoder config set modelName gpt-4o ## Next Steps -- Learn about [basic usage](./usage.md) -- Explore the [configuration options](./usage/configuration.md) +- Learn about [basic usage](../usage) +- Explore the [configuration options](../usage/configuration) - Join our [Discord community](https://discord.gg/5K6TYrHGHt) \ No newline at end of file diff --git a/docs/intro.md b/docs/index.md similarity index 96% rename from docs/intro.md rename to docs/index.md index f25c61e..0eb6da1 100644 --- a/docs/intro.md +++ b/docs/index.md @@ -50,8 +50,8 @@ MyCoder can help with a wide variety of development tasks: To start using MyCoder, check out the following sections: -- [Installation and setup](./getting-started.md) -- [Basic usage and commands](./usage.md) +- [Installation and setup](./getting-started/index.mdx) +- [Basic usage and commands](./usage/index.mdx) - [Configuration options](./usage/configuration.md) ## Community diff --git a/docs/usage.md b/docs/usage/index.mdx similarity index 96% rename from docs/usage.md rename to docs/usage/index.mdx index 3d1789b..6d908a8 100644 --- a/docs/usage.md +++ b/docs/usage/index.mdx @@ -6,6 +6,7 @@ sidebar_position: 3 Learn how to use MyCoder effectively for your development tasks. + ## Basic Usage ### Running with a Prompt @@ -103,7 +104,7 @@ To enable GitHub mode: mycoder config set githubMode true ``` -This requires the GitHub CLI (`gh`) to be installed and authenticated. For more details, see the [GitHub Mode documentation](./usage/github-mode.md). +This requires the GitHub CLI (`gh`) to be installed and authenticated. For more details, see the [GitHub Mode documentation](./github-mode). ## Available Tools @@ -121,6 +122,6 @@ MyCoder has access to a variety of tools that enable it to perform complex tasks For more detailed information about specific features, check the following pages: -- [Configuration Options](./usage/configuration.md) -- [GitHub Mode](./usage/github-mode.md) -- [Performance Profiling](./usage/performance-profiling.md) \ No newline at end of file +- [Configuration Options](./configuration) +- [GitHub Mode](./github-mode) +- [Performance Profiling](./performance-profiling) \ No newline at end of file diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 7ba04b8..2d6abec 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -20,7 +20,7 @@ function HomepageHeader() {