Qore.works Business technical documentation

Introduction

The official Qore.works Business documentation is published on docs.qore.works.

vitepress

We are using vitepress to publish the documentation from Qore.works Business.

The documentation files are organized in multiple packages and can be found here

qore-works-base/docs
qore-frontend/docs
qore-relation/docs

Add package documentation

To add documentation for a new package, you should add an index.md file in the /docs/ path to the package.

Next add the public key to the Access key section of the package repository with read access qore-works-business-documentation

After you created the initial documentation file, you can add the package to the document scanner build-docs.sh.

file get_docs_from_repo qore-package-repo-name

Also add the package to the main menu config.mts so it can be accessed.

View changes during development

To view the changes during documentation development you can run the command:

chmod +x localbuild/build_docs.sh
./localbuild/build_docs.sh

You can view the built documentation at docs.qore.works.local.dolphiq.eu

Due to the way documentation is built from different repositories, it is not possible to watch changes in realtime. Therefore, every time you make a change, you should rerun the build_docs.sh command.