Skip to content

Plugin system#6

Merged
hitomihiumi merged 8 commits intomainfrom
plugin-system
Sep 21, 2025
Merged

Plugin system#6
hitomihiumi merged 8 commits intomainfrom
plugin-system

Conversation

@hitomihiumi
Copy link
Copy Markdown
Member

This pull request sets up the foundation for the Magic Docs documentation app, including configuration, deployment, and core documentation features. The most important changes are grouped below:

Deployment & CI/CD Setup

  • Added a GitHub Actions workflow (.github/workflows/deploy.yml) to automatically build and deploy the documentation site to Vercel on pushes and pull requests to main and master branches.
  • Added .vercelignore and .gitignore files to ensure only relevant files are deployed and versioned, improving build performance and security. [1] [2]

Documentation App Configuration

  • Added a comprehensive next.config.mjs for Next.js, enabling MDX support, optimizing images, customizing Webpack, and configuring experimental features for better performance and flexibility.
  • Added package.json with dependencies for Next.js, MDX, Once UI, and supporting libraries, along with scripts for development, build, lint, and deployment.
  • Added biome.json to configure code formatting, linting, and import organization for consistent code style.
  • Added ESLint configuration (.eslintrc.json) to customize linting rules for React and Next.js.

Core Documentation Features

  • Implemented the main dynamic docs page (src/app/(docs)/[...slug]/page.tsx) with support for metadata generation, MDX rendering, navigation, and adjacent page links. (apps/docs/src/app/(docs)/[...slug]/page.tsxR1-R157)
  • Added docs layout (src/app/(docs)/layout.tsx) and sidebar integration for structured navigation.
  • Created API routes for navigation (src/app/api/navigation/route.ts) and metadata fetching (src/app/api/og/fetch/route.ts) to support dynamic features and Open Graph integration. [1] [2]

Project Documentation & Licensing

  • Added README.md with project overview, setup instructions, features, and deployment guidance.
  • Included a LICENSE file specifying Creative Commons BY-NC 4.0 licensing for non-commercial use.

@hitomihiumi hitomihiumi merged commit f71f775 into main Sep 21, 2025
1 check failed
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.

1 participant