Sequelize/CONTRIBUTING.DOCS.md

Documentation

The sequelize documentation is divided in two parts:

• Tutorials, guides, and example based documentation are written in Markdown
• The API reference is generated automatically from source code comments and types with TypeDoc.

The tutorials, written in markdown, are located at the website repository.

To generate the API reference locally, run yarn docs and open the generated .typedoc-build/index.html in your favorite browser.

The whole documentation is rendered using Docusaurus and continuously deployed to https://sequelize.org. See the website repository for more information.