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
5 changes: 2 additions & 3 deletions .github/workflows/code-quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -241,9 +241,8 @@ jobs:
# formatter failure mode that made the old `.prettierrc` worth deleting.
# Centralising the config never stopped drift; the gate does.
# Measured on this tree before enabling: PASSES, 294 of 310 tracked
# frontend files in scope. This repo has TWO documentation trees and both
# are excluded by .prettierignore — `docs/` and the separate `docusaurus/`
# site, which has its own package.json and its own toolchain.
# frontend files in scope. The documentation site in `docs/` is excluded
# by .prettierignore: it has its own package.json and its own toolchain.
# `check:l10n-js` regenerates l10n/<locale>.js from the JSON catalogue and
# fails when the committed file is stale. Nextcloud serves ONLY the JS half
# to a browser — raw JSON out of an app directory is a 404 — so a catalogue
Expand Down
8 changes: 3 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
.phpunit.cache/

/node_modules/
/website/node_modules/
/website/.docusaurus/
/js/
# Host-side apps dir bind-mounted by docker-compose.yml; App Store installs
# land here. Only the placeholder that keeps the directory is tracked.
Expand Down Expand Up @@ -87,9 +85,9 @@ docker/dolphin/models/
!issues/
!issues/**

/docusaurus/node_modules/
/docusaurus/build/
/docusaurus/.docusaurus/
# Docusaurus writes its build cache here, with absolute paths from the machine
# that built it. It was committed once; never again.
.docusaurus/
# Test screenshots — images generated by browser test commands (test-app, run-test-scenario)
# Only images are ignored; markdown reports and scenario files are kept in git.
test-results/**/*.png
Expand Down
6 changes: 2 additions & 4 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@ coverage-vitest/
playwright-report/
test-results/
*.min.*
# This repo carries TWO Docusaurus trees, `docs/` and `docusaurus/`. Both are
# documentation sites with their own conventions (their CSS is space-indented
# by Docusaurus' own scaffolding), and both are built by a separate toolchain.
# `docs/` is the Docusaurus documentation site. It has its own conventions (its
# CSS is space-indented by Docusaurus' own scaffolding) and its own toolchain.
docs/
docusaurus/
# Written by the translation workflow — a formatter here would fight its own
# generator on every run.
l10n/
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,12 +209,12 @@ Each release automatically:

## Documentation Release Process

Documentation is built with [Docusaurus](https://docusaurus.io/) and deployed to GitHub Pages.
Documentation is built with [Docusaurus](https://docusaurus.io/) and served by a Cloudflare Worker.

1. Documentation source lives in the `docs/` (or `docusaurus/`) folder on any branch
2. Push or merge to the `documentation` branch triggers the build
1. Documentation source lives in the `docs/` folder
2. A push or merge to `development` triggers the build (`.github/workflows/documentation.yml`)
3. Docusaurus builds the static site
4. The site is deployed to GitHub Pages with a custom domain (e.g., `openregister.app`)
4. The site is published to [keepiq.conduction.nl](https://keepiq.conduction.nl)

Each app has its own documentation site — see the app's README for its URL.

Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,10 @@ keepiq/
│ ├── architecture/ # App-specific Architectural Decision Records
│ ├── ROADMAP.md # Product roadmap
│ └── changes/ # OpenSpec change directories (created on first change)
├── docs/ # Design documentation
├── docs/ # Documentation site (Docusaurus) and design documentation
│ ├── ARCHITECTURE.md # Standards, data model, integrations
│ ├── FEATURES.md # Competitive analysis, feature matrix
│ └── DESIGN-REFERENCES.md # Design patterns, ASCII wireframes
├── docusaurus/ # Documentation site
├── tests/ # Unit and integration tests
├── l10n/ # Translations — 36 locales, <locale>.json + generated <locale>.js
├── .github/workflows/ # CI/CD pipelines
Expand Down
5 changes: 0 additions & 5 deletions docs/.docusaurus/DONT-EDIT-THIS-FOLDER

This file was deleted.

Loading
Loading