KADAI - Documentation for the open source task management library

This repository contains the website for the documentation of KADAI.

KADAI is a task management component open source library. It can be embedded into your application or be operated standalone if appropriate. Beside the basic task management functionalities, KADAI adds workbaskets and classifications to control and monitor a large amount of Tasks within a larger organization.

🔨Build

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

  npm run build

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

  npm run start

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

📚Versioning

We align versioning of our documentation with the release of major versions in terms of Semantic Versioning.

Therefore, we keep patching the current (major) version until the next (major) version is released. The /docs folder represents the current version while older, unmaintained versions reside in /versioned_docs.

Let's consider publishing the next version A.B.C and assume our current version is X.Y.Z. We want to publish A.B.C. Therefore:

1. open a command-line in the project's root and run

  npm run docusaurus docs:version X.Y.Z

2. set the label of the new current version A.B.C in /docusaurus.config.js at config.presets.docs.versions.current.label to vA.B.C,

({
  // ...
  versions: {
    current: {
      label: 'vA.B.C',
      path: '/',
      badge: true
    },
    // ...
  }
  // ...
})

3. add the new previous version X.Y.Z there:

({
  // ...
  versions: {
    current: {
      label: 'vA.B.C',
      path: '/',
      badge: true
    },
    "X.Y.Z": {
      label: 'vX.Y.Z',
      path: 'X.Y.Z',
      badge: true
    },
    // ...
  }
  // ...
})

4. move the version "current" in ./versions.json above "X.Y.Z", it should now look like:

[
  "current",
  "X.Y.Z"
]

You did it! The current version is now A.B.C and the previous version is now X.Y.Z. Now we maintain the current version simply by editing in the /docs folder.

If we need to edit an older version, e.g. the previous version, we can edit in /versioned_docs/version-X.Y.Z.

📨Contact

If you have any questions or ideas feel free to create an issue, contact us via GitHub Discussions or E-mail us at kadai@envite.de.

We love listening to your feedback, and of course also discussing the project roadmap and possible use cases with you!

This open source project is being developed by envite consulting GmbH with the support of the open source community.

---