From 0c176573f19f3d6fb202ac064e07008af6fee172 Mon Sep 17 00:00:00 2001 From: eshanized Date: Sat, 4 Jan 2025 17:29:07 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20detailed=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 200 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 177 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 0c6c2c27..6027d3c3 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,195 @@ -# Website +### πŸ“ **Snigdha OS Documentation Repository** -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +Welcome to the **Snigdha OS Documentation Repository**! πŸš€ +This repository contains all official documentation, guides, and resources for **Snigdha OS**, a lightweight and customizable Linux distribution optimized for penetration testing, ethical hacking, and cybersecurity. -### Installation -``` -$ yarn + +### πŸ“– **Contents of the Repository** + +- **User Guides**: Step-by-step instructions to install, configure, and use Snigdha OS. +- **Developer Documentation**: Guides for contributing to Snigdha OS development. +- **Community Guidelines**: Rules and best practices for contributing and interacting within the Snigdha OS community. +- **Translation Resources**: Tools and instructions for translating the documentation into other languages. + + + +### πŸš€ **Getting Started** + +#### **1️⃣ Explore the Documentation** +Visit the **[Snigdha OS Documentation Website](https://snigdha-os.github.io/documentation/)** to access: +- Installation guides. +- Troubleshooting tips. +- Contribution guidelines. + +#### **2️⃣ Clone the Repository** +If you want to contribute or make changes, clone the repository to your local machine: +```bash +git clone https://github.com/Snigdha-OS/documentation.git +cd documentation ``` -### Local Development - -``` -$ yarn start +#### **3️⃣ Install Dependencies** +To preview or edit the documentation locally, install the required dependencies: +```bash +npm install ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +#### **4️⃣ Start the Local Development Server** +Run the following command to preview changes in real-time: +```bash +npm run start +``` -### Build + +### 🌟 **How to Contribute** + +We welcome contributions from the community! Here’s how you can help: + +#### **1️⃣ Report Issues** +If you find bugs, errors, or areas for improvement, open an issue in the [GitHub Issues Tracker](https://github.com/Snigdha-OS/documentation/issues). + +#### **2️⃣ Submit Changes** +1. Fork the repository. +2. Create a new branch: + ```bash + git checkout -b your-feature-name + ``` +3. Make your changes. +4. Commit and push your changes: + ```bash + git commit -m "Description of changes" + git push origin your-feature-name + ``` +5. Open a pull request (PR). + +#### **3️⃣ Translate Documentation** +Help make Snigdha OS accessible to a global audience by translating the documentation into your language. See the **[Translation Guide](https://github.com/Snigdha-OS/documentation/blob/main/TRANSLATION_GUIDE.md)** for details. + + + +### πŸ› οΈ **Technologies Used** + +This repository is built using [Docusaurus](https://docusaurus.io/), a modern static site generator optimized for project documentation. + +Key technologies: +- **React** +- **Markdown** +- **TypeScript** + + + +### πŸ“¬ **Contact & Support** + +For questions, suggestions, or help: +- **Discussions**: [Join the Conversation](https://github.com/Snigdha-OS/documentation/discussions) +- **Email**: hello@snigdhaos.org + + + +### ❀️ **Acknowledgments** + +We deeply appreciate all contributors, users, and community members who help make Snigdha OS better. Your feedback and support drive our success! + + + +### πŸ“œ **License** + +This repository is licensed under the **[MIT License](LICENSE)**. By contributing, you agree that your contributions will be licensed under the same terms. + + + +**Let’s build Snigdha OS together! 🌍✨** + +### πŸ“ **Translation Guide for Snigdha OS Documentation** + +Welcome to the **Translation Guide** for Snigdha OS documentation! 🌍 +Contributing translations helps make Snigdha OS more accessible to people worldwide. Follow this guide to start translating content into your preferred language. + + + +### πŸš€ **Getting Started with Translation** + +#### **1️⃣ Fork and Clone the Repository** +1. Visit the [Snigdha OS Documentation Repository](https://github.com/Snigdha-OS/documentation). +2. Click the **Fork** button to create your own copy of the repository. +3. Clone your forked repository to your local machine: + ```bash + git clone https://github.com//documentation.git + cd documentation + ``` + +#### **2️⃣ Create a New Branch** +Create a branch for your translation work: +```bash +git checkout -b translate/ +``` +For example, to translate into Hindi, create a branch `translate/hi`. + +#### **3️⃣ Add a Language Folder** +Navigate to the `i18n` folder in the repository. If the folder for your language does not exist, create one. The folder name should match the language code (e.g., `hi` for Hindi, `fr` for French). + +**Structure Example**: ``` -$ yarn build +i18n/ +β”œβ”€β”€ en/ (default English folder) +β”œβ”€β”€ hi/ (new Hindi folder) +β”œβ”€β”€ fr/ (French folder) ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. +#### **4️⃣ Translate Strings** +- **Docusaurus Strings**: Open the file at `i18n//docusaurus-theme.json` and replace English strings with your translations. +- **Markdown Files**: Copy content from the `docs` folder into your language's folder (e.g., `i18n/hi/docs`) and translate the text inside each file. -### Deployment -Using SSH: -``` -$ USE_SSH=true yarn deploy -``` +### πŸ”„ **Syncing Updates** -Not using SSH: +If the original documentation (in English) changes: +1. Sync your fork with the upstream repository: + ```bash + git fetch upstream + git merge upstream/main + ``` +2. Update translations to reflect the latest changes. -``` -$ GIT_USER= yarn deploy -``` -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. + +### βœ… **Submit Your Translation** + +1. **Stage and Commit Changes**: + ```bash + git add . + git commit -m "Add Hindi translations for Snigdha OS documentation" + ``` +2. **Push Your Branch**: + ```bash + git push origin translate/ + ``` +3. **Open a Pull Request (PR)**: + - Go to your forked repository on GitHub. + - Click the **Compare & Pull Request** button. + - Provide a clear title and description for your PR, mentioning the language you translated. + + + +### 🌟 **Translation Best Practices** + +- **Consistency**: Use consistent terminology for technical terms. +- **Context**: Understand the context before translating a term. +- **Tone**: Maintain a professional yet approachable tone. +- **Review**: Proofread your translations for accuracy and fluency. + + + +### πŸ’¬ **Need Help?** + +- **Contact Us**: Reach out via [GitHub Discussions](https://github.com/Snigdha-OS/documentation/discussions). +- **Ask for Review**: Tag maintainers for feedback on your translations. + + + +### ❀️ **Thank You for Contributing!** + +Your efforts make Snigdha OS more inclusive and user-friendly for a global audience. Together, let’s make cybersecurity accessible for everyone. πŸš€βœ¨ \ No newline at end of file