Contributing to TechCraft Docs
Thank you for considering contributing to TechCraft Docs! Your contributions are valuable, and we welcome them with open arms.
🌟 Getting Started#
To contribute, follow these simple steps:
1. 🍴 Fork, Clone, or Download#
Fork this project on GitLab
Clone the repository to your local machine:
2. 🛠 Install Docusaurus#
Navigate to the website directory and install the dependencies:
3. 👀 Preview the Project#
Start the development server to preview your changes:
Visit your site at http://localhost:3000 in your web browser.
4. 📝 Add Content#
Contribute by adding or modifying content in the project.
5. 🚧 Generate the Website (Optional)#
If you make significant changes and want to generate the static website:
The built website will be located in the website/build/ directory.
6. 📚 Read More#
For more details and advanced usage, refer to the Docusaurus documentation.
🤝 How to Contribute#
- If you find a bug, open an issue.
- If you have a suggestion or improvement, create a merge request (MR).
Your contributions are what make TechCraft Docs amazing! Thank you for helping us improve.
🛠 Dependencies#
Ensure you have the following dependencies installed:
- Node.js
- Yarn
Happy contributing! 🎉