Skip to content
kelviqPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

406 Commits

Folders and files

Repository files navigation

Kelviq Documentation

Complete documentation for Kelviq, the SaaS monetization and subscription management platform.

Getting Started

For Product Teams

For Developers

Key Features

Product Management

Monetization

  • Checkout - Configure and customize checkout
  • Customers - Manage customer subscriptions
  • Webhooks - Real-time event notifications
  • Webhooks - Real-time event notifications

Developer Tools

Common Tasks

Troubleshooting

Having issues? Check the Troubleshooting Guide for solutions to common problems.

Support

Local Development

To preview documentation changes locally:

Install Mintlify CLI

npm i -g mint

Run dev server

mint dev

View preview

Open http://localhost:3000 in your browser.

Deploying Changes

Changes to the main branch are automatically deployed to production.

To preview changes before deployment:

  1. Create a branch
  2. Make changes
  3. Create a pull request
  4. Preview changes in the Mintlify dashboard
  5. Merge to deploy

Documentation Structure

/docs
├── getstarted/          # Getting started guides
├── quickstart/          # Quickstart and core concepts
├── product-catalog/     # Product management docs
├── checkout/            # Checkout configuration
├── customers/           # Customer management
├── api-reference/       # API docs and error codes
├── webhooks/            # Webhook documentation
├── frontend-integration/# Frontend SDKs
├── troubleshooting/     # Troubleshooting guides
└── docs.json           # Navigation and config

Contributing

To contribute to Kelviq docs:

  1. Make your changes in the appropriate directory
  2. Test locally with mint dev
  3. Create a pull request
  4. After approval, merge to main
  5. Changes deploy automatically

Style Guide

  • Use clear, developer-friendly language
  • Include code examples for API features
  • Use Mintlify components for formatting
  • Link to related documentation
  • Keep sections concise and focused

Changelog

All release notes live in one page, changelog.mdx, newest first. Add each release as an <Update> at the top of the page, tagged with the product exactly as it appears in the filter. The product filter above the entries matches on that tag, and so does the sidebar:

<Update label="v2.9.0" description="October 1, 2026" tags={["Node SDK"]}>
...
</Update>

Keep the label a plain string; an expression label loses its anchor link. Products are App, JS SDK, React SDK, Node SDK, Python SDK, JS Promotions UI, MCP Server, CLI, and API.

The sidebar lists the same products, as anchors under the Changelog tab in docs.json. They must be written as absolute URLs (https://docs.kelviq.com/changelog#node-sdk): Mintlify rewrites a relative href containing a hash to /. Absolute URLs would open in a new tab, so ChangelogFilter rewrites them back to same-page links once the page loads. To add a product, add it in three places: the products list passed to <ChangelogFilter>, the anchors in docs.json, and the redirect if the product had its own page before.

Those anchors would otherwise carry an icon and no group title, so custom.css hides the icon, heads the list with "Changelog", and highlights whichever product is selected. Those rules only apply while ChangelogFilter is on screen, which it marks with data-changelog-page on the body.

Need Help?

  • Can't find something? - Use the search feature (top of page)
  • Having issues? - Check Troubleshooting
  • Want to report a bug? - Email hi@kelviq.com
  • Have suggestions? - We'd love your feedback!

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

Generated from mintlify/starter