We welcome feedback and
In order to run the documentation locally, install the dependencies and run the development server:
$ npm install
$ npm startWe recommend npm -v 8+ and Node.js -v 16+.
The Codat docs are built using Docusaurus. Content written primarily in Markdown, though React JSX is also valid.
Before submitting an issue to the Codat docs repo, please search existing issues to avoid duplicate reports.
If the issue you're reporting is a bug, please be sure it is an issue with the Codat docs themselves and not the subject of the documentation. With your report, please provide:
- Steps to reproduce
- Expected behavior
- OS and browser versions
- If possible, a demo repo or CodePen/CodeSandbox
Note: Some reference content is pulled from other Codat repos. In that case, please submit your issue on the docs repo with a link to the repo where the content lives.
When submitting pull requests, please keep the scope of your change contained to a single feature or bug. When in doubt, err on the side of smaller pull requests. If your pull request is a new feature, we would recommend opening an issue first to come to an agreement about the feature before putting in significant time.
The repo's main branch is deployed automatically.
This repo is licensed and managed separately from Codat itself.
By contributing to this repo, you agree to have your contributions licensed under the Apache 2.0 license. See LICENSE for the full license text.