kata-platform-docs

Documentation website for the Kata Platform

Welcome to the GitHub project for the Kata Platform documentation! We've built this site from the ground-up with performance, accessibility, and fanciness in mind. You can access the documentation website at https://docs.kata.ai

Contributing

Something is missing/incorrect? Don't hesitate to create a pull request! The following section outlines how you can contribute to our documentation site.

Development guide

Prerequisites

Node.js (8.0.0+)
Yarn (Optional. You can still use npm if you want, but highly recommended for your own sanity.)

Initial setup

Clone this repository.

git clone https://github.com/kata-ai/kata-platform-docs.git

cd to the generated project. Here we'll have to install our node dependencies. To do so, run (one of) the following command(s).

# npm
npm install
# yarn
yarn

Running the server

To start working on this documentation, you need to start a development server.

# npm
npm run dev
# yarn
yarn dev

Commit message guidelines

We use Commitizen with the cz-conventional-changelog standard. We included the Commitizen CLI inside the repository so that you can generate a formatted commit message simply by typing yarn commit (or npm commit).

Format

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The first line must contain a commit type, an optional scope, and the subject of the commit.

The message body contains a longer description of the change. This is reserved for any information that won't fit inside the subject line of a commit message. Note that each line of the commit message should not be longer than 72 characters.

Footer is optional, and contains any additional information for the commit (e.g. issues fixed, breaking changes).

Commit types

We use the following conventional-changelog commit types:

feat:     A new feature
fix:      A bug fix
docs:     Documentation only changes
style:    Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf:     A code change that improves performance
test:     Adding missing tests or correcting existing tests
build:    Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci:       Changes to our CI configuration files and scripts (example scopes: travis, circle)
chore:    Other changes that don't modify src or test files
revert:   Reverts a previous commit

Credits

This project is bootstrapped with Grundgesetz, a documentation skeleton for Gatsby made by Kata.ai.

Authors

Resi Respati (@resir014) – Kata.ai

ycjcl868 / kata-platform-docs Goto Github PK