Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.73 KB

Contributing to SessionBase Documentation

Thank you for your interest in improving SessionBase documentation! We welcome contributions to help make our docs clearer and more comprehensive.

Getting Started

Development Setup

  1. Install the Mintlify CLI:

    npm i -g mint

  2. Run the development server:

    mint dev

  3. View your changes at http://localhost:3000

Contributing Guidelines

Documentation Standards

  • Write clearly and concisely - assume users are new to SessionBase
  • Include practical examples - show real commands and expected outputs
  • Keep it up to date - if CLI behavior changes, update the docs
  • Use consistent formatting - follow existing markdown patterns

Before Submitting

  • Test all code examples and commands
  • Preview your changes with mint dev
  • Check that links work correctly
  • Ensure proper grammar and spelling

Pull Request Process

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your documentation changes
  4. Test locally with mint dev
  5. Submit a pull request with:
    • Clear description of what you changed
    • Why the change was needed
    • Screenshots if applicable

Types of Contributions

  • Fix errors - typos, broken links, incorrect examples
  • Add missing content - new platform guides, troubleshooting steps
  • Improve clarity - better explanations, additional examples
  • Update outdated content - keep pace with CLI changes

Questions?

Licensing

By contributing, you agree that your contributions will be licensed under the MIT License.