An open API service indexing awesome lists of open source software.

https://github.com/livechat/livechat-public-docs

The source of Text Platform Documentation.
https://github.com/livechat/livechat-public-docs

api chat docs documentation integration js-api livechat rest-api

Last synced: about 12 hours ago
JSON representation

The source of Text Platform Documentation.

Awesome Lists containing this project

README

          

# Platform Docs

[![Netlify Status](https://api.netlify.com/api/v1/badges/64c9d8bf-8fe6-4481-91d9-4258c3b9ae91/deploy-status)](https://app.netlify.com/sites/livechat-public-docs/deploys)

Hello 👋!

This is the repository for the [Platform documentation](https://platform.text.com/docs/).
Our documents are written in the [MDX format](https://mdxjs.com/), so pay attention to our custom tags when contributing to the docs.

## Who we are

Behind Text, Inc. there is a team of [passionate people](https://www.text.com/team/) building online customer service software with online chat, help desk software, chatbot, and web analytics capabilities.

With a suite of five products ([LiveChat](https://www.livechat.com/), [ChatBot](https://www.chatbot.com/), [HelpDesk](https://www.helpdesk.com/), [KnowledgeBase](https://www.knowledgebase.ai/), and [OpenWidget](https://openwidget.com/)) and their powerful APIs, we power customer communication for 37,000 companies in 150 countries.

[The Platform](https://platform.text.com/) is a range of products and services that can be used to build a variety of communication tools for businesses. Our [Technology Program](https://www.text.com/partners/technology/) creates an open ecosystem for developers and partners who want to build custom solutions for Text customers.

## Node version

We require node version 14.x.

## Development

1. Fetch the repository
2. Run `npm install`
3. Run `npm run dev`
4. Run `netlify env:pull`
5. Open http://localhost:3000/docs

## Production

We are using **Netlify** to serve the docs in production.

You can simulate the production build process locally by running.

1. Run `npm run build`
2. Run `npm start`

## Feature branch / Deploy preview

In order to test your work before merging to master, **Netlify** provides **Deploy Preview**. When raising a PR, GitHub will provide **Netlify** notifications with the **Deploy Preview** url that can be found in the checks section.

## Versioning

Every change automatically updates the documentation version. Versions are built based on commit messages, so adherence to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) is required.

## How to contribute

All contribution's welcome! [Read how to do it.](./CONTRIBUTING.md)

## Get in touch

- [Join our Discord for Developers](https://discord.gg/rFbJkYQFwp)
- Send us an email at developers@text.com
- Follow us on [X](https://x.com/TextPlatform)