Welcome to the official documentation repository for Langtrace. We welcome contributions from everyone. This guide will help you get started with contributing to our documentation.
This repository contains the source files for the Langtrace documentation. Our goal is to provide clear, accurate, and helpful documentation for all users.
To contribute to the documentation, follow these steps:
- Fork the repository: Click the "Fork" button at the top right corner of this page to create a copy of this repository under your GitHub account.
- Clone your fork: Clone your forked repository to your local machine.
git clone https://github.com/your-username/your-fork.git
- Create a new branch:
git checkout -b feature-branch
- Make your changes to the docs.
- Test your changes thoroughly and verify no broken links with pre-comit checker.
- Commit your changes with a clear and descriptive commit message:
git commit -m "Description of your changes"
- Push your changes to your fork:
git push origin feature-branch- Open a pull request from your fork to the main repository.
- In the pull request description, provide a clear explanation of your changes and why they should be merged.
- Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
npm i -g mintlify
- Install pre-commit
brew install pre-commit
- Run the following command at the root (where mint.json is)
mintlify dev
- Mintlify dev isn't running - Run
mintlify installit'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
mint.json
To ensure consistency and quality in our documentation, please follow these guidelines: • Ensure no broken links by installing pre-commit • Markdown Standards: Use Markdown for all documentation files. • Clarity and Accuracy: Ensure that your contributions are clear, accurate, and well-organized.
Thank you for contributing!