Skip to content

Commit

Permalink
Add readme (#33)
Browse files Browse the repository at this point in the history
Co-authored-by: timpratim <[email protected]>
  • Loading branch information
timpratim and timpratim authored Jan 17, 2025
1 parent d132453 commit 722bca1
Showing 1 changed file with 63 additions and 1 deletion.
64 changes: 63 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,63 @@
# Treblle Documentation
# 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/)

1 comment on commit 722bca1

@vercel
Copy link

@vercel vercel bot commented on 722bca1 Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.