Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make docs consistent on the use of terminology #4042

Open
stephanie0x00 opened this issue Jan 22, 2025 · 0 comments
Open

Make docs consistent on the use of terminology #4042

stephanie0x00 opened this issue Jan 22, 2025 · 0 comments
Assignees
Labels
chore discussion documentation Improvements or additions to documentation

Comments

@stephanie0x00
Copy link
Contributor

stephanie0x00 commented Jan 22, 2025

Describe the issue
The usage of OpenKAT requires a learning curve from the community. One of the reasons is the usage of terminology like: Mula, Rocky, bits, Whiskers, etc. while we also use some terms interchangeably. In practice we don't use Mula and Whiskers (as mentioned on the website and docs) but call them Scheduler and Normalizers. This makes it confusing for new users to get started.

In an ideal situation the user in the front-end shouldn't be confronted too much with all the different terms for our modules. As users just want to use the tool as quickly as possible instead of having to learn new things.

Let's try to keep KISS in mind. :)

How are we going to call the following items in the web-interface and/or docs.openkat.nl?

  • Mula or Scheduler?
  • Whiskers or Normalizers?
  • Bits and nibbles?
  • .... other?

Expected behavior
Consistent writing across all pages in the docs and web-interface on terminology to make OpenKAT easy to understand.

@stephanie0x00 stephanie0x00 added chore documentation Improvements or additions to documentation labels Jan 22, 2025
@stephanie0x00 stephanie0x00 self-assigned this Jan 22, 2025
@github-project-automation github-project-automation bot moved this to Incoming features / Need assessment in KAT Jan 22, 2025
@stephanie0x00 stephanie0x00 changed the title Make docs consistent on the use of Mula vs scheduler Make docs consistent on the use of terminology Jan 22, 2025
@stephanie0x00 stephanie0x00 moved this from Incoming features / Need assessment to To be discussed in KAT Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore discussion documentation Improvements or additions to documentation
Projects
Status: To be discussed
Development

No branches or pull requests

1 participant