Skip to content

Commit aa95277

Browse files
committed
fix: versioning fixes
1 parent 3bea902 commit aa95277

File tree

8 files changed

+117
-12
lines changed

8 files changed

+117
-12
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ node_modules/
22
.github/
33
.next/
44
.source/
5-
.claude/
5+
.claude/
6+
.vercel

README.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Dragonfly Documentation
2+
3+
The official documentation site for [Dragonfly](https://github.com/df-mc/dragonfly) — a fast, lightweight Minecraft Bedrock Edition server written in Go.
4+
5+
## Tech Stack
6+
7+
- **Framework**: [Next.js 16](https://nextjs.org/) with React 19
8+
- **Documentation**: [Fumadocs](https://fumadocs.vercel.app/) for MDX-based documentation
9+
- **Styling**: Tailwind CSS 4 with Framer Motion animations
10+
- **Package Manager**: [Bun](https://bun.sh/)
11+
12+
## Getting Started
13+
14+
### Prerequisites
15+
16+
- [Bun](https://bun.sh/) (recommended) or Node.js 18+
17+
18+
### Installation
19+
20+
```bash
21+
# Clone the repository
22+
git clone https://github.com/df-mc/docs.git
23+
cd docs
24+
25+
# Install dependencies
26+
bun install
27+
```
28+
29+
### Development
30+
31+
```bash
32+
# Start the development server
33+
bun run dev
34+
```
35+
36+
Open [http://localhost:3000](http://localhost:3000) in your browser.
37+
38+
### Build
39+
40+
```bash
41+
# Build for production
42+
bun run build
43+
44+
# Start the production server
45+
bun run start
46+
```
47+
48+
## Project Structure
49+
50+
```
51+
dragonfly-docs/
52+
├── app/ # Next.js app router pages
53+
├── components/ # React components
54+
├── content/
55+
│ └── docs/ # Documentation content (MDX)
56+
│ ├── changelogs/ # Version changelogs
57+
│ ├── community/ # Community resources
58+
│ ├── core-concepts/ # Core concepts & architecture
59+
│ ├── getting-started/ # Quick start guides
60+
│ ├── migration/ # Migration guides
61+
│ ├── reference/ # API reference
62+
│ ├── source/ # Source code documentation
63+
│ └── tutorials/ # Step-by-step tutorials
64+
├── lib/ # Utility functions
65+
├── public/ # Static assets
66+
└── static/ # Additional static files
67+
```
68+
69+
## Contributing
70+
71+
Contributions are welcome! To contribute:
72+
73+
1. Fork the repository
74+
2. Create a feature branch (`git checkout -b feature/my-feature`)
75+
3. Make your changes
76+
4. Commit your changes (`git commit -m 'Add some feature'`)
77+
5. Push to the branch (`git push origin feature/my-feature`)
78+
6. Open a Pull Request
79+
80+
### Writing Documentation
81+
82+
Documentation is written in MDX format. Create or edit files in the `content/docs/` directory. Each page should include frontmatter:
83+
84+
```mdx
85+
---
86+
title: Page Title
87+
description: A brief description of the page
88+
---
89+
90+
Your content here...
91+
```
92+
93+
## Scripts
94+
95+
| Command | Description |
96+
|---------|-------------|
97+
| `bun run dev` | Start development server |
98+
| `bun run build` | Build for production |
99+
| `bun run start` | Start production server |
100+
| `bun run lint` | Run ESLint |
101+
| `bun run type-check` | Run TypeScript type checking |
102+
103+
## License
104+
105+
This project is part of the Dragonfly ecosystem. See the main [Dragonfly repository](https://github.com/df-mc/dragonfly) for license information.

bun.lock

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

content/docs/source/meta.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"description": "Dragonfly API documentation",
33
"pages": [
44
"block",
5-
"block-cube",
65
"block-cube-trace",
76
"block-customblock",
87
"block-model",

next-env.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// <reference types="next" />
22
/// <reference types="next/image-types/global" />
3-
import "./.next/dev/types/routes.d.ts";
3+
import "./.next/types/routes.d.ts";
44

55
// NOTE: This file should not be edited
66
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

next.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const withMDX = createMDX();
66
const nextConfig = {
77
reactStrictMode: true,
88
experimental: {
9-
optimizePackageImports: ['lucide-react', 'geist']
9+
optimizePackageImports: ['lucide-react', 'geist'],
1010
},
1111
images: {
1212
domains: ['github.com', 'discord.com', 'user-images.githubusercontent.com', 'discordapp.com', 'avatars.githubusercontent.com', 'go.dev'],

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
"next": "16.1.1",
2626
"next-themes": "^0.4.6",
2727
"prism-react-renderer": "^2.4.1",
28-
"react": "19.0.0",
29-
"react-dom": "19.0.0",
28+
"react": "^19.2.0",
29+
"react-dom": "^19.2.0",
3030
"react-use-measure": "^2.1.7",
3131
"tailwind-merge": "^2.0.0",
3232
"tailwindcss": "latest",
@@ -40,4 +40,4 @@
4040
"postcss": "^8.4.0",
4141
"typescript": "^5.0.0"
4242
}
43-
}
43+
}

0 commit comments

Comments
 (0)