docs: add readme

Author: PeriniM

README.md

@@ -1,32 +1,98 @@
-# Mintlify Starter Kit
+# 📚 ScrapeGraphAPI Documentation
 
-Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
+<p align="center">
+  <img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/api-banner.png" alt="ScrapeGraphAPI Logo"/>
+</p>
 
-- Guide pages
-- Navigation
-- Customizations
-- API Reference pages
-- Use of popular components
+<p align="center">
+  <a href="https://docs.scrapegraphai.com">Documentation</a> |
+  <a href="https://scrapegraphai.com">Website</a> |
+  <a href="https://discord.gg/uJN7TYcpNa">Discord</a>
+</p>
 
-### Development
+This repository contains the official documentation for ScrapeGraphAPI, a suite of AI-powered web scraping tools. Our documentation is built using [Mintlify](https://mintlify.com), providing a modern and interactive documentation experience.
 
-Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
+## 🚀 Quick Start
 
-```
+### Prerequisites
+
+Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation locally:
+
+```bash
 npm i -g mintlify
 ```
 
-Run the following command at the root of your documentation (where mint.json is)
+### Local Development
 
-```
+1. Clone this repository
+2. Navigate to the documentation directory
+3. Run the development server:
+
+```bash
 mintlify dev
 ```
 
-### Publishing Changes
+The documentation will be available at `http://localhost:3000`.
+
+## 📚 Documentation Structure
+
+```
+.
+├── introduction.mdx          # Main introduction page
+├── services/                 # Core services documentation
+│   ├── smartscraper.mdx     # SmartScraper service
+│   ├── localscraper.mdx     # LocalScraper service
+│   ├── markdownify.mdx      # Markdownify service
+│   └── extensions/          # Browser extensions
+│       └── firefox.mdx      # Firefox extension
+├── sdks/                    # SDK documentation
+│   ├── python.mdx          # Python SDK
+│   └── javascript.mdx      # JavaScript SDK
+└── api-reference/          # API reference documentation
+```
+
+## 🤝 Contributing
+
+We welcome contributions to improve our documentation! Here's how you can help:
+
+1. Fork this repository
+2. Create a new branch for your changes
+3. Make your changes to the documentation
+4. Test locally using `mintlify dev`
+5. Submit a pull request
+
+### Contribution Guidelines
+
+- Follow the existing documentation structure
+- Use Markdown and MDX for content
+- Include clear commit messages
+- Test all changes locally before submitting
+- Update the navigation in `mint.json` if adding new pages
+
+## 🛠️ Development Tools
+
+- **Mintlify**: Documentation framework
+- **MDX**: Extended Markdown syntax
+- **React**: For interactive components
+- **Node.js**: Required for local development
+
+## 📝 License
+
+This documentation is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🔗 Useful Links
+
+- [ScrapeGraphAI Website](https://scrapegraphai.com)
+- [API Documentation](https://docs.scrapegraphai.com/api-reference/introduction)
+- [Discord Community](https://discord.gg/uJN7TYcpNa)
+- [GitHub Organization](https://github.com/ScrapeGraphAI)
+
+## 💡 Need Help?
 
-Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. 
+- Join our [Discord community](https://discord.gg/uJN7TYcpNa)
+- Email us at [[email protected]](mailto:[email protected])
+- Check our [status page](https://scrapegraphapi.openstatus.dev)
 
-#### Troubleshooting
+## ⭐ Show Your Support
 
-- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
-- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
+If you find our documentation helpful, please consider giving us a star on GitHub!