Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Documentation

on:
push:
branches: [documentation]
branches: [development, documentation]
pull_request:
branches: [documentation]
branches: [development, documentation]

jobs:
deploy:
Expand Down
14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Procest is a case management (zaakgericht werken) application for Nextcloud, des

| Feature | Screenshot |
|---------|------------|
| Dashboard | ![Dashboard](screenshots/dashboard.png) |
| My Work | ![My Work](screenshots/my-work.png) |
| Cases | ![Cases](screenshots/case-management.png) |
| Tasks | ![Tasks](screenshots/task-management.png) |
| Case Types | ![Case Types](screenshots/case-types.png) |
| Admin Settings | ![Settings](screenshots/admin-settings.png) |
| ZGW Configuration | ![ZGW Config](screenshots/zaaktype-configuratie.png) |
| Dashboard | ![Dashboard](/screenshots/dashboard.png) |
| My Work | ![My Work](/screenshots/my-work.png) |
| Cases | ![Cases](/screenshots/case-management.png) |
| Tasks | ![Tasks](/screenshots/task-management.png) |
| Case Types | ![Case Types](/screenshots/case-types.png) |
| Admin Settings | ![Settings](/screenshots/admin-settings.png) |
| ZGW Configuration | ![ZGW Config](/screenshots/zaaktype-configuratie.png) |

## Feature Documentation

Expand Down
21 changes: 16 additions & 5 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,18 @@ const config = createConfig({
organizationName: 'ConductionNL',
projectName: 'procest',

/* Procest ships en + nl markdown; the brand preset's default i18n
block (nl/en/de/fr) is replaced wholesale here so we don't pull
in stub locales the docs don't translate yet. */
/* English-only until the docs actually ship translated markdown.
Per ADR-030: a `locales` array carrying `nl` without a populated
`docs/i18n/nl/docusaurus-plugin-content-docs/current/` directory
of translated markdown triggers SSR rendering errors ("Cannot read
properties of undefined (reading 'id')") on tutorial pages when the
docs source moves faster than the locale's `current.json`. Trim to
`['en']`; re-add `nl` once the translation backfill lands. */
i18n: {
defaultLocale: 'en',
locales: ['en', 'nl'],
locales: ['en'],
localeConfigs: {
en: { label: 'English' },
nl: { label: 'Nederlands' },
},
},

Expand Down Expand Up @@ -126,6 +129,14 @@ const config = createConfig({
markdown directly so it makes it into the final Docusaurus config. */
config.markdown = {
mermaid: true,
/* Tutorial pages (docs/tutorials/) reference screenshots populated by
tests/e2e/docs-screenshots.spec.ts. The Playwright capture run is
separate from the docs build, so the build must succeed even when a
fresh checkout doesn't have every PNG yet. Warn instead of failing
(ADR-030); flip to 'throw' once all screenshots are committed. */
hooks: {
onBrokenMarkdownImages: 'warn',
},
};

module.exports = config;
4 changes: 2 additions & 2 deletions docs/features/admin-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Configuration page (under Settings) provides the central administration panel for Procest.

![Admin Settings](../screenshots/admin-settings.png)
![Admin Settings](/screenshots/admin-settings.png)

## Overview

Expand All @@ -27,7 +27,7 @@ The configuration section allows administrators to map Procest to OpenRegister s

## ZGW API Mapping

![ZGW API Mapping](../screenshots/zaaktype-configuratie.png)
![ZGW API Mapping](/screenshots/zaaktype-configuratie.png)

The settings page includes the ZGW (Zaakgericht Werken) API mapping configuration, which maps English-language OpenRegister property names to their Dutch ZGW API equivalents. This ensures compatibility with the Dutch government's ZGW standard for case management.

Expand Down
2 changes: 1 addition & 1 deletion docs/features/case-dashboard-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The case dashboard view shows the detail page for an individual case, accessible by clicking on a case from the My Work list or the Cases list.

![Case Dashboard View](../screenshots/case-dashboard-view.png)
![Case Dashboard View](/screenshots/case-dashboard-view.png)

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/features/case-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Case Types page (under Settings) allows administrators to manage case type definitions and their configurations.

![Case Types](../screenshots/case-types.png)
![Case Types](/screenshots/case-types.png)

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/features/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Procest dashboard is the landing page of the application, providing a high-level overview of the current user's case management workload.

![Dashboard](../screenshots/dashboard.png)
![Dashboard](/screenshots/dashboard.png)

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/features/my-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The My Work view shows all cases and tasks assigned to the currently logged-in user, providing a personal work queue.

![My Work](../screenshots/my-work.png)
![My Work](/screenshots/my-work.png)

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/features/task-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Tasks view provides a list of all tasks in the system, functioning similarly to the Cases view.

![Task Management](../screenshots/task-management.png)
![Task Management](/screenshots/task-management.png)

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/features/zaaktype-configuratie.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The zaaktype configuration is part of the Settings area and provides ZGW-compliant case type management.

![Zaaktype Configuration](../screenshots/zaaktype-configuratie.png)
![Zaaktype Configuration](/screenshots/zaaktype-configuratie.png)

## Overview

Expand Down
File renamed without changes
11 changes: 11 additions & 0 deletions docs/tutorials/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"label": "Tutorials",
"position": 2,
"collapsible": true,
"collapsed": false,
"link": {
"type": "generated-index",
"title": "Tutorials",
"description": "Step-by-step walkthroughs for everyday tasks. The user track covers individual workflows; the admin track covers org-wide configuration."
}
}
35 changes: 35 additions & 0 deletions docs/tutorials/admin/01-configure-case-types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 1
title: Configure case types and workflows
description: Step-by-step guide to Configure case types and workflows
---

# Configure case types and workflows

Step-by-step guide to Configure case types and workflows

## Goal

{{TODO: write the goal}}

## Prerequisites

{{TODO: list prerequisites}}

## Steps

{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}

## Verification

{{TODO: how the user confirms it worked}}

## Common issues

| Symptom | Fix |
|---|---|
{{TODO: rows}}

## Reference

{{TODO: cross-link into features/*.md}}
35 changes: 35 additions & 0 deletions docs/tutorials/admin/02-automatic-actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 2
title: Set up automatic actions
description: Step-by-step guide to Set up automatic actions
---

# Set up automatic actions

Step-by-step guide to Set up automatic actions

## Goal

{{TODO: write the goal}}

## Prerequisites

{{TODO: list prerequisites}}

## Steps

{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}

## Verification

{{TODO: how the user confirms it worked}}

## Common issues

| Symptom | Fix |
|---|---|
{{TODO: rows}}

## Reference

{{TODO: cross-link into features/*.md}}
35 changes: 35 additions & 0 deletions docs/tutorials/admin/03-admin-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 3
title: Manage Procest settings
description: Step-by-step guide to Manage Procest settings
---

# Manage Procest settings

Step-by-step guide to Manage Procest settings

## Goal

{{TODO: write the goal}}

## Prerequisites

{{TODO: list prerequisites}}

## Steps

{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}

## Verification

{{TODO: how the user confirms it worked}}

## Common issues

| Symptom | Fix |
|---|---|
{{TODO: rows}}

## Reference

{{TODO: cross-link into features/*.md}}
11 changes: 11 additions & 0 deletions docs/tutorials/admin/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"label": "Admin guide",
"position": 2,
"collapsible": true,
"collapsed": true,
"link": {
"type": "generated-index",
"title": "Admin guide",
"description": "Org-wide administration — toggling features, configuring policies, and managing users or groups."
}
}
35 changes: 35 additions & 0 deletions docs/tutorials/user/01-first-launch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 1
title: Open Procest for the first time
description: Step-by-step guide to Open Procest for the first time
---

# Open Procest for the first time

Step-by-step guide to Open Procest for the first time

## Goal

{{TODO: write the goal}}

## Prerequisites

{{TODO: list prerequisites}}

## Steps

{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}

## Verification

{{TODO: how the user confirms it worked}}

## Common issues

| Symptom | Fix |
|---|---|
{{TODO: rows}}

## Reference

{{TODO: cross-link into features/*.md}}
35 changes: 35 additions & 0 deletions docs/tutorials/user/02-my-work.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 2
title: Find your work in My Work
description: Step-by-step guide to Find your work in My Work
---

# Find your work in My Work

Step-by-step guide to Find your work in My Work

## Goal

{{TODO: write the goal}}

## Prerequisites

{{TODO: list prerequisites}}

## Steps

{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}

## Verification

{{TODO: how the user confirms it worked}}

## Common issues

| Symptom | Fix |
|---|---|
{{TODO: rows}}

## Reference

{{TODO: cross-link into features/*.md}}
35 changes: 35 additions & 0 deletions docs/tutorials/user/03-view-case.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 3
title: Open and read a case
description: Step-by-step guide to Open and read a case
---

# Open and read a case

Step-by-step guide to Open and read a case

## Goal

{{TODO: write the goal}}

## Prerequisites

{{TODO: list prerequisites}}

## Steps

{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}

## Verification

{{TODO: how the user confirms it worked}}

## Common issues

| Symptom | Fix |
|---|---|
{{TODO: rows}}

## Reference

{{TODO: cross-link into features/*.md}}
Loading
Loading