TestProf documentation

TestProf docs website driven by docsify.

This repo only contains assets and general docs (not related to a particular TestProf library).

Most of the documentation lives in the main repo.

Contributing

The quickest way to fix a typo or propose a small change is to use GitHub web interface (open a file, click on "Edit", create a PR).

If you want to propose a bigger change, you might want to use a common flow:

1. Fork it.
2. Create a new branch (git checkout -b feat/my-proposal).
3. Commit and push changes.
4. Open new Pull Request.

Translations

Each localization lives in its own repository:

• Russian: https://github.com/test-prof/docs-ru
• Chinese: https://github.com/test-prof/docs-zh-cn
• Japanese: https://github.com/test-prof/docs-ja

See the guide on working on translations.

Linters

We try to keep our documentation both correct and stylish using the following tools:

• mdl—Markdown linter, Ruby edition.
• liche—links linter.
• forspell—spelling checker.
• RuboCop with rubocop-md and standard—Ruby code snippets style checking.

To run these tools locally we use Lefthook (runs linters automatically for every commit).

To sum up:

• Install mdl:

gem install mdl

• Install liche:

go get -u github.com/raviqqe/liche

• Install Hunspell and Forspell:

# for MacOS (for other OS see Forspell documentation)
brew install hunspell

gem install forspell

• Install StandardRB and rubocop-md:

gem install standard
gem install rubocop-md

• Install lefthook:

# for MacOS (for other OS see Lefthook documentation)
brew install lefthook

• Initialize lefthook:

lefthook install

Or you can skip all of these and rely on our CI, which can do all the checks for you!