feat: readme update

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+<!-- Thank you for opening a PR! We really appreciate you taking the time to help out 🙌 -->
+
+#### What Type of Change is this?
+
+- [ ] New Page
+- [ ] Minor Fix
+- [ ] Major Improvement
+
+#### Description (required)
+
+<!-- Please describe the change you are proposing, and why -->
+
+#### Related issues & labels (optional)
+
+- Closes #<!-- Add an issue number  -->
+
+
+<!-- #### First-time contributor to Zerops Docs? -->
+
+<!-- Join our Discord Server  -->
+<!-- https://discord.gg/xxzmJSDKPT -->

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Build
+
+on:
+  push:
+   branches:
+     - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build
+        run: yarn build
+

CODE_OF_CONDUCT.md

@@ -0,0 +1,16 @@
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+- Examples of unacceptable behavior by participants include:
+
+The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting

CONTRIBUTING.md

@@ -1,7 +1,71 @@
-```sh
-yarn
-```
+# Contributing to Zerops Docs
 
-```sh
-yarn dev
-```
+We're excited you're interested in contributing to our Turborepo-based Docusaurus documentation! This guide will help you get started.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/en/) (version 18 or above)
+- [Yarn](https://yarnpkg.com/) package manager
+
+## Project Structure
+
+This project uses Turborepo to manage a monorepo structure. The documentation site is likely one of the workspaces within this structure.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork: `git clone https://github.com/your-username/repo-name.git`
+3. Navigate to the project directory: `cd repo-name`
+4. Install dependencies: `yarn`
+5. Create a new branch: `git checkout -b your-branch-name`
+
+## Running the Site Locally
+
+1. Start the development server: `yarn dev`
+   This command uses Turborepo to run the dev script in the documentation workspace.
+2. Open your browser and visit `http://localhost:3001`.
+
+## Making Changes
+
+1. Make your changes in the appropriate workspace (likely in the `docs` or similar directory)
+2. Test your changes locally using the development server
+3. Run `yarn build` to ensure your changes don't cause build errors across the monorepo
+4. Commit your changes: `git commit -m "Your descriptive commit message"`
+5. Push to your fork: `git push origin your-branch-name`
+
+## Submitting a Pull Request
+
+1. Go to the original repository on GitHub
+2. Click the "New pull request" button
+3. Select your fork and the branch containing your changes
+4. Fill out the pull request template with details about your changes
+5. Submit the pull request
+
+## Other Commands
+
+- `yarn build`: Builds all workspaces in the monorepo
+- `yarn lint`: Runs linting across all workspaces
+- `yarn test`: Runs tests across all workspaces (if configured)
+
+Check for more scripts in `package.json`.
+
+Refer to the `turbo.json` file in the root of the repository for more details on the configured pipelines.
+
+## Style Guide
+
+- Use Markdown for all documentation files in the docs workspace
+- Follow the [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features) guide
+- Use sentence case for headings
+- Keep line length to a maximum of 80 characters
+- Use American English spelling
+- Adapt to our pattern
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## Need Help?
+
+If you have any questions or need help with your contribution, please open an issue or reach out to the maintainers.
+
+Thank you for contributing to [Repository Name]!

README.md

@@ -1,15 +1,42 @@
-# Zerops Documentation
-https://docs.zerops.io
+![Docs cover](https://github.com/zeropsio/recipe-shared-assets/blob/main/covers/svg/cover-docs.svg)
+
+<h2>Zerops Documentation</h2>
+
+[![CI](https://img.shields.io/github/actions/workflow/status/zeropsio/docs/build.yml?labelColor=EDEFF3&color=8F9DA8)](https://github.com/zeropsio/docs/actions/workflows/build.yml)
+![GitHub contributors](https://img.shields.io/github/contributors/zeropsio/docs?labelColor=EDEFF3&color=8F9DA8)
+[![Discord](https://img.shields.io/discord/735781031147208777?labelColor=EDEFF3&color=8F9DA8)](https://discord.gg/xxzmJSDKPT)
+![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/zeropsio)
+
+Our <b>Documentation</b> for people who want help with interacting with <a href="https://zerops.io/" target="_blank">Zerops</a> platform. <a href="https://docs.zerops.io/" target="_blank">Read the docs →</a>
+
+### About
+
+This repository utilizes the powerful [MedusaJS Docs](http://docs.medusajs.com/) theme and components, combined with Docusaurus, to serve users a seamless documentation experience.
 
-Docusaurus theme and components from the amazing and powerful https://medusajs.com
 
 ## Contributing Guide
 
-Checkout [CONTRIBUTING.md](https://github.com/zeropsio/docs/blob/main/CONTRIBUTING.md).
+If you're planning to contribute to our documentation, please check out our [CONTRIBUTING.md](https://github.com/zeropsio/docs/blob/main/CONTRIBUTING.md) guide.
 
+If you have any questions, please feel free to join [Zerops Discord Server](https://discord.gg/xxzmJSDKPT).
 
 ## Links
 
-- [Twitter](https://x.com/zeropsio)
-- [Discord Server](https://discord.gg/xxzmJSDKPT)
-- [LinkedIn](https://www.linkedin.com/company/zerops)
+<p align="center">
+  <b>
+  <a href="https://x.com/zeropsio">Twitter</a>
+  •
+  <a href="https://discord.gg/xxzmJSDKPT">Discord Server</a>
+  •
+  <a href="http://linkedin.com/company/zerops/">LinkedIn</a>
+  </b>
+</p>
+
+<br/>
+
+<p align="center">
+<b>Made with</b> ❤️ for <b>Documentation</b> lovers.
+<br/>
+</p>
+
+<p align="end"><img height="36" src="https://github.com/zeropsio/recipe-shared-assets/blob/main/logos/zerops-green.svg" ></p>