dbus-serialbattery documentation

This documentation is built using Docusaurus 3, a modern static website generator.

It can be found at https://mr-manuel.github.io/venus-os_dbus-serialbattery_docs.

Contribution

To contribute to this documentation you have to fork this repository, add or edit the content in the docs folder and then open a pull request to merge your changes.

Local Development

This command installs all missing dependencies:

yarn

Build

This command generates static content into the build directory and can be served using any static contents hosting service:

yarn build

Start local server

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server:

npm run serve

OR

yarn start

but with yarn not everything seems to work.

Create a new documentation version

This command creates a new version of the documentation. This allows to match the documentation always to the current version of the driver.

yarn docusaurus docs:version v1.5.20241202

For more informations see https://docusaurus.io/docs/versioning.

Upgrade Docusaurus to the latest version

This command updates Docusaurus to the latest version:

yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest

Possible problems and resolutions

yarn command not found

Install it by executing this command:

npm install --global yarn

npm command not found

Download and install it from nodejs.org.