Welcome to NamasteDev Docs! 🎉
This repository hosts the documentation content for various projects, which is published at NamasteDev Docs.
We believe in open collaboration! If you find something incorrect, notice a missing topic, or want to contribute your own project documentation, feel free to submit a Pull Request (PR). 👏
- Fork this repository.
- Add your Markdown (
.md
) file inside the appropriate folder. - Ensure your file includes the following frontmatter, for reference check the projects which are already curated by us:
--- sidebar_position: <your_position_here> ---
- Create a PR, and we'll review it soon!
Inside the docs
folder, you'll find three main project categories:
- advanced-projects/ 🚀 - For high-level, complex projects.
- beginner-level-projects/ 🌱 - For simple, easy-to-follow projects.
- intermediate-projects/ 🔥 - For moderately challenging projects.
You can add your project’s documentation (.md
file) in the most relevant category.
If you want to include images in your documentation, follow these steps:
- Place your images inside the
img
folder within your project category directory. - Reference them in your Markdown file using the relative path:
![Image Description](img/your-image.png)
- Ensure your images are in a web-friendly format such as
.png
,.jpg
, or.gif
. - Keep file names clear and descriptive.
- Use clear and concise language.
- Include step-by-step instructions where possible.
- If your project has a demo or repo, add relevant links.
- Feel free to include images and code snippets for better understanding.
Regards,
Team NamasteDev 🚀