|
1 | | -# Website |
| 1 | +# MyCoder Documentation |
2 | 2 |
|
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 |
4 | 18 |
|
5 | 19 | ### Installation |
6 | 20 |
|
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 |
9 | 28 | ``` |
10 | 29 |
|
11 | 30 | ### Local Development |
12 | 31 |
|
13 | | -``` |
14 | | -$ yarn start |
| 32 | +```bash |
| 33 | +# Start the development server |
| 34 | +yarn start |
15 | 35 | ``` |
16 | 36 |
|
17 | 37 | This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
18 | 38 |
|
19 | 39 | ### Build |
20 | 40 |
|
21 | | -``` |
22 | | -$ yarn build |
| 41 | +```bash |
| 42 | +# Generate static content |
| 43 | +yarn build |
23 | 44 | ``` |
24 | 45 |
|
25 | 46 | This command generates static content into the `build` directory and can be served using any static contents hosting service. |
26 | 47 |
|
27 | 48 | ### Deployment |
28 | 49 |
|
29 | | -Using SSH: |
30 | | - |
31 | | -``` |
32 | | -$ USE_SSH=true yarn deploy |
| 50 | +```bash |
| 51 | +# Deploy to GitHub Pages |
| 52 | +USE_SSH=true yarn deploy |
33 | 53 | ``` |
34 | 54 |
|
35 | | -Not using SSH: |
| 55 | +Or if not using SSH: |
36 | 56 |
|
| 57 | +```bash |
| 58 | +GIT_USER=<Your GitHub username> yarn deploy |
37 | 59 | ``` |
38 | | -$ GIT_USER=<Your GitHub username> yarn deploy |
39 | | -``` |
40 | 60 |
|
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). |
0 commit comments