This website is the documentation for qmBase.
This website is built using Docusaurus 2, a modern static website generator.
help.qmbase.com
Download and install VS Code clone this repository and follow the instructions.
yarn installyarn startThis command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Follow these steps to edit the documents:
- Open Visual Studio Code (if it's not installed, download it from https://code.visualstudio.com/).
- From the left sidebar, click on Source Control then click Clone Repository.
- Paste the repository URL of qmBase/docs GitHub repository (https://github.com/qmBase/docs.git) and click Clone from URL.
- Select a path (any folder) where the files will be cloned to.
- After the cloning process is finished, a pop-up message will show up, click Open to open the cloned repository in Visual Studio Code.
- Now create a new branch by clicking main in the bottom left, and choose Create new branch and name it then press enter. (use your initials at the beginning, for example: [ab]/BranchName)
- Do your edits and changes and save them.
- Click on Source Control from the left sidebar.
- Enter a message about the changes you made and press Commit, then Publish Branch.
- Now in GitHub, make a Pull Request, then merge your branch with the main branch.
If you do not have installed VS Code on you local machine you can also Open the repository in in the browser. This make writing new documents easier than working on the raw files on Github Go to https://vscode.dev/github/qmBase/docs and follow the instructions.
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
This project will be deployed to an azure static web app via the azure-pipelines.yml file
npm run lint:spellingThis command runs a spell check using CSpell. If you want any specific words to be ignored by the spell checker, add them to the words list in the project-words.txt file.
- Primary: #65ace0
Icons we use can be found at react-icons.
The screenshots are automatically generated via Cypress. You can see the full list of screenshots here under the gallery section. If you require more screenshots please file a new issue.
Path of screenshots equals path in app.
The template for app documentation can be found in /docs/tutorial-template. If the document you write is incomplete please write
| App | Entity | Comments | Files | Audit Trail | Custom Fields | Workflows | Costs |
|---|---|---|---|---|---|---|---|
| Absence planner | x | x | x | x | |||
| Audit management | x | x | x | x | |||
| Blog | x | x | x | ||||
| Claim management | x | x | x | x | x | ||
| CRM | Contacts | x | x | x | x | ||
| CRM | Ratings | x | x | ||||
| Document management | x | x | x | ||||
| Employees | x | x | x | ||||
| Error management | x | x | x | x | x | ||
| Forms | x | ||||||
| Functions & Qualifications | Non Standard | ||||||
| Goal management | x | x | x | x | x | ||
| Idea management | x | x | x | ||||
| Maintenance | Inventory items | x | x | x | x | ||
| Maintenance | Inspections done | x | |||||
| Projects & Tasks | Projects | x | x | x | |||
| Projects & Tasks | Tasks | x | x | x | x | x | |
| Products | x | x | x | x | |||
| Risks & Chances | x | x | x | x | |||
| Trainings | x | x | x | x | x | ||
| WIKI | x | x | x |
| App / App | Absence planner | Audit management | Blog | Claim management | CRM | Document management | Employees | Error management | Forms | Functions & Qualifications | Goal management | Idea management | Maintenance | Projects & Tasks | Products | Risks & Chances | Trainings | WIKI |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Absence planner | ||||||||||||||||||
| Audit management | x | x | x | x | ||||||||||||||
| Blog | ||||||||||||||||||
| Claim management | x | x | x | x | ||||||||||||||
| CRM | x | x | ||||||||||||||||
| Document management | ||||||||||||||||||
| Employees | ||||||||||||||||||
| Error management | x | x | x | |||||||||||||||
| Forms | ||||||||||||||||||
| Functions & Qualifications | x | |||||||||||||||||
| Goal management | x | x | ||||||||||||||||
| Idea management | ||||||||||||||||||
| Maintenance | x | |||||||||||||||||
| Projects & Tasks | x | x | x | x | x | x | x | x | x | x | x | x | ||||||
| Products | x | x | x | |||||||||||||||
| Risks & Chances | x | |||||||||||||||||
| Trainings | x | x | x | x | ||||||||||||||
| WIKI |
How to create a good home page?
https://www.smashingmagazine.com/2018/02/comprehensive-guide-to-mobile-app-design/
- Minimize Cognitive Load
- DECLUTTERING
- USE FAMILIAR SCREEN
- MINIMIZE USER INPUT
- ANTICIPATE USERS NEEDS
- Focus On The First-Time Experience
- DESIGN A GOOD ONBOARDING EXPERIENCE
- Don’t Ask For Set-Up Information Up Front
- PUSH THE VALUE
| Item | Priority | Multiple entities | Apps | |
|---|---|---|---|---|
| My dashboard / Action required | 1 | Y | -> Notification + my items + Action required | |
| My status | Y | Absence planner | Remove | |
| Pinned entries | -1 | Use everywhere | ||
| Comments | Y | Remove | ||
| Notification | Unify with 1 | |||
| Smart Views | Y | Remove | ||
| Common tasks | Functions & Qualifications | Move to sidebar | ||
| Global filter | Functions & Qualifications | Move to settings in app | ||
| Access your content | Blog, Doc, Wiki | Remove / Move to sidebar | ||
| Quick access | 0 | Blog, Doc, Wiki | ||
| Tags | ? | Sidebar + Modal | ||
| Actions in this app | ? | Forms | Unify | |
| Action required v1 | ? | Ideas | Unify | |
| Action required v2 | ? | Trainings | Unify | |
| Bot | ? | Merge in action required as second part | ||
| Workflows | ? | AppSettings | ||
| Pending connected tasks | ? | Claim Management | ||
| Notification for all new | ? | Claim Management | Move to App settings | |
| App overview | ? | Dashboard & Reporting | leave as it is | |
| Custom | ? | Admin | Clean up only action required | |
| Custom | ? | Profile | leave as it is | |
| Search results | ? | Settings | leave as it is | |
| New here card | ? | IdeaManagement | Unify under condition no action required + zero data created | |
| Prerequisites | ? | App lock screen modal with overview of required / missing data and permission info |
Known Issues should be documented in the dedicated folder ./docs/knownIssues/ if the source is a ticket use the {id}.md as file name. If the source is a internal ticket use the {id}_intern.md as file name.
Add the tag docs:KnownIssue to the ticket so that we have a reference there. If multiple tickets reference a knownIssue entry put the link to the knownIssue as a comment to the ticket.
my-docusaurus-site/
│
├── package.json
├── docusaurus.config.ts
├── sidebars.ts
├── tsconfig.json
├── README.md
│
├── docs/ # 📘 Main documentation (Markdown-first)
│ ├── index.md # /docs landing page
│ │
│ ├── intro/ # Logical grouping
│ │ ├── index.md
│ │ └── getting-started.md
│ │
│ ├── guides/
│ │ ├── index.md
│ │ ├── installation.md
│ │ └── configuration.md
│ │
│ ├── reference/
│ │ ├── index.md
│ │ ├── cli.md
│ │ └── api.md
│ │
│ └── _meta/ # ❗ AI / structural metadata
│ ├── vision.md
│ ├── audience.md
│ ├── non-goals.md
│ └── glossary.md
│
├── blog/ # 📰 Blog posts
│ ├── 2026-01-01-welcome.md
│ └── authors.yml
│
├── src/ # ⚛️ React customization
│ ├── components/
│ ├── pages/
│ ├── css/
│ │ └── custom.css
│ └── theme/
│ └── DocItem/
│ └── index.tsx
│
├── static/ # 🖼️ Static assets
│ ├── img/
│ └── files/
│
├── scripts/ # 🤖 AI / automation scripts
│ ├── validate-docs.ts
│ ├── generate-docs.ts
│ └── lint-frontmatter.ts
│
├── .agents/ # 🧠 AI control & memory
│ ├── rules.md
│ ├── memory.md
│ ├── changelog.md
│ └── prompts/
│ ├── doc-writer.md
│ ├── editor.md
│ └── reviewer.md
│
└── .gitignore
docs/ = source of truth
- Every folder → sidebar category
index.md→ category landing page- Frontmatter controls navigation, ordering, labels
1️⃣ Keep _meta/ separate
This prevents accidental publishing.
docs/_meta/
vision.md # Why this site exists
audience.md # Personas
non-goals.md
2️⃣ One page = one responsibility
Avoid giant Markdown files.
✅ installation.md ❌ everything.md
3️⃣ Stable paths
Renaming files breaks links and agent memory.
Agents should:
- ❌ Avoid touching
src/theme/unless necessary - ✅ Add components only when Markdown is insufficient
Typical cases:
- Interactive diagrams
- Custom callouts
- Auth-aware content
static/img/docs/
static/img/blog/
.agents/
├── rules.md # Global constraints
├── memory.md # Decisions & context
├── changelog.md # What the AI changed
└── prompts/
Example rules.md:
- Do not change published docs without explicit instruction
- Prefer modifying existing files
- Ask before creating new categories
System prompt:
You are an AI documentation agent for a Quality Management SaaS.
Before acting, you must:
1. Read and follow all files in `.agents/`
2. Treat `.agents/constraints.md` as absolute
3. Treat `.agents/rules.md` as behavioral law
4. Treat `docs/_meta/*` as canonical domain truth
5. Preserve terminology defined in `_meta/terminology.md`
You may:
- Edit documentation Markdown files
- Improve clarity without changing meaning
You must never:
- Modify `.agents/` files
- Modify `docs/_meta/`
- Invent features or compliance claims
- Change the meaning of existing content
All changes must be logged in `.agents/changelog.md`.
If a request violates any rule, stop and explain why.
Second prompt: How tasks should be given to the agent
“Improve the docs for qualifications”
“Clarify how qualification validity resets work in docs/guides/qualifications/validity.md. Do not change compliance meaning. Preserve terminology. Log changes.”
The more constrained, the better.