From 722bca1f577dd409f9c13217d747f53cbc242b65 Mon Sep 17 00:00:00 2001 From: Pratim Date: Fri, 17 Jan 2025 15:56:52 +0100 Subject: [PATCH] Add readme (#33) Co-authored-by: timpratim --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 31975bd..f6c3f0e 100644 --- a/README.md +++ b/README.md @@ -1 +1,63 @@ -# Treblle Documentation \ No newline at end of file +# Treblle Documentation + +This repository contains the official documentation for [Treblle](https://www.treblle.com/). +Treblle is an API Ops platform that helps engineers and product teams build, ship, and understand their REST APIs in one single place. The documentation is built using [Astro](https://astro.build/), a modern static site generator. + +## 🚀 Quick Start + +1. Clone the repository: + + ```bash + git clone https://github.com/Treblle/docs.treblle.com.git + cd docs.treblle.com + ``` + +2. Install dependencies: + + ```bash + npm install + ``` + +3. Start the development server: + + ```bash + npm run dev + ``` + +## 📚 Documentation Structure + +- `/src/content/docs/` - Main documentation content + - `/treblle/` - Core Treblle features and functionality + - `/integrations/` - Integration guides for different platforms + - `/features/` - Detailed feature documentation + +## 🛠️ Contributing + +We welcome contributions! If you'd like to improve our documentation: + +1. Fork the repository +2. Create a feature branch +3. Make your changes +4. Submit a pull request + +Please ensure your documentation follows our style guide and includes clear, concise explanations. + +## 🔧 Local Development + +The documentation site is built with: + +- [Astro](https://astro.build/) - Static site generator +- [Starlight](https://starlight.astro.build/) - Documentation theme +- [MDX](https://mdxjs.com/) - Markdown with JSX support + +## 📝 License + +[MIT License](LICENSE) + +## 🤝 Support + +If you need help or have questions: + +- [Join our Community](https://discord.gg/UqfrkqcN) +- [Visit our Website](https://treblle.com) +- [Read our Blog](https://blog.treblle.com/)