Skip to main content

Improving Serenity/JS documentation

Serenity-js.org website is made up of two main components:

Serenity/JS Handbook​

The Serenity/JS Handbook is an evolving project and there are parts of the book that you might find incomplete, or simply not written yet.

You can contribute to the evolution of the Serenity/JS Handbook by:

  • correcting any errors you find - via Edit this page link at the bottom of each page and raising a Pull Request
  • sharing your ideas for topics you'd like to see covered - via GitHub issues
  • sponsoring the Serenity/JS project via the GitHub Sponsors Programme, so that the maintainers can secure more time to write and improve the documentation for you
Commit message format

When contributing documentation changes, please make sure to follow the Serenity/JS conventional commit message format. For example:

docs(website): fixed a typo in the XYZ article

Serenity/JS API Docs​

The Serenity/JS API Documentation is generated automatically based on the TSDoc comments in the codebase. If you spot an issue in the API docs or want to add a new example, click on the code icon next to the name of the class or method of interest, just like this one here.

The code icon will take you straight to the TSDoc used to generate a given description or example, which you can fix via Pull Request the same way you'd fix the code.

Proposing changes to the website​

The Serenity/JS website is located under documentation in the Serenity/JS mono-repo.

The website is built with Docusaurus and uses the Docusaurus Plugin TypeDoc API to produce the API docs.

To start the local development server, run:

make install
cd documentation/serenity-js.org
npm start
note

While Docusaurus supports hot reloading, the TypeDoc API plugin does not just yet. If you're working on updating the API docs, you'll need to restart the development server to see your changes.

To test the build process, run:

make install
make site
Did you know?

Serenity/JS works with Gitpod.io, which means you can preview Serenity/JS website and the API docs with your proposed changes right here in your browser, without having to set up or install anything on your computer.

To learn more about Gitpod, check out Gitpod Screencasts, or jump straight into Serenity/JS codebase using the button below.

Open in Gitpod