Skip to content

Commit 9ab67f8

Browse files
committed
Remove default blog posts and tutorial directories
1 parent 91f8fba commit 9ab67f8

17 files changed

+55
-623
lines changed

README.md

Lines changed: 55 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,80 @@
1-
# Website
1+
# MyCoder Documentation
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
This repository contains the official documentation for MyCoder, an AI-powered coding assistant. The documentation is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
## What's Inside
6+
7+
- **Product Documentation**: Comprehensive guides on how to use MyCoder
8+
- **Getting Started**: Platform-specific setup instructions for Windows, macOS, and Linux
9+
- **Usage Guides**: Detailed information on features and capabilities
10+
- **Blog**: Updates, tutorials, and insights about MyCoder
11+
12+
## Development
13+
14+
### Prerequisites
15+
16+
- Node.js version 18.0 or above
17+
- npm or yarn
418

519
### Installation
620

7-
```
8-
$ yarn
21+
```bash
22+
# Clone the repository
23+
git clone https://github.com/drivecore/mycoder-docs.git
24+
cd mycoder-docs
25+
26+
# Install dependencies
27+
yarn
928
```
1029

1130
### Local Development
1231

13-
```
14-
$ yarn start
32+
```bash
33+
# Start the development server
34+
yarn start
1535
```
1636

1737
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1838

1939
### Build
2040

21-
```
22-
$ yarn build
41+
```bash
42+
# Generate static content
43+
yarn build
2344
```
2445

2546
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2647

2748
### Deployment
2849

29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true yarn deploy
50+
```bash
51+
# Deploy to GitHub Pages
52+
USE_SSH=true yarn deploy
3353
```
3454

35-
Not using SSH:
55+
Or if not using SSH:
3656

57+
```bash
58+
GIT_USER=<Your GitHub username> yarn deploy
3759
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
4060

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
61+
The site is automatically deployed when changes are pushed to the main branch.
62+
63+
## Contributing
64+
65+
We welcome contributions to improve the documentation:
66+
67+
1. Fork the repository
68+
2. Create a feature branch (`git checkout -b feature/amazing-improvement`)
69+
3. Make your changes
70+
4. Commit your changes (`git commit -m 'Add some amazing improvement'`)
71+
5. Push to the branch (`git push origin feature/amazing-improvement`)
72+
6. Open a Pull Request
73+
74+
## License
75+
76+
This project is licensed under the MIT License - see the LICENSE file for details.
77+
78+
## Contact
79+
80+
If you have questions or feedback, please join our [Discord community](https://discord.gg/5K6TYrHGHt).

blog/2019-05-28-first-blog-post.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

blog/2019-05-29-long-blog-post.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

blog/2021-08-01-mdx-blog-post.mdx

Lines changed: 0 additions & 24 deletions
This file was deleted.

blog/2021-08-26-welcome/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/tutorial-basics/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/tutorial-basics/congratulations.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

docs/tutorial-basics/create-a-blog-post.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/tutorial-basics/create-a-document.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/tutorial-basics/create-a-page.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)