Improving Serenity/JS documentation
Serenity-js.org website is made up of two main components:
- Serenity/JS Handbook with articles and tutorials helping you to get started with the framework
- Serenity/JS API Documentation describing the public APIs available to developers using Serenity/JS to build their tests and test automation systems.
The website is built with Docusaurus, uses the Docusaurus Plugin TypeDoc API to generate the API documentation,
and you'll find its source code in the serenity-js/serenity-js.org repository on GitHub.
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 typos or other errors you might find
- 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
To submit simple content fixes, such as correcting typos, you can use the Edit this page link at the bottom of each page and raise a Pull Request
using the GitHub web interface.
To work on more complex changes, such as adding new features or restructuring the website, follow the setup instructions in the README.md to set up the website on your local machine or use the free virtual workspace provided by Gitpod.io.
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.
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.
