-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: timpratim <[email protected]>
- Loading branch information
Showing
1 changed file
with
63 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/) |
722bca1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
docs-treblle-com β ./
docs-treblle-com.vercel.app
docs-treblle-com-git-main-treblle-pro.vercel.app
docs.treblle.com
docs-treblle-com-treblle-pro.vercel.app