Skip to content

docs(schemas): keep spec ids and em-dashes out of text a user reads #528

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.

Sign up for GitHub

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

Merged
rubenvdlinde merged 1 commit into from
Sep 3, 2026
Merged

docs(schemas): keep spec ids and em-dashes out of text a user reads #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions lib/Settings/launchpad_mock_register.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"x-openregister": {
"type": "mock",
"app": "launchpad",
"description": "Demo data for launchpad. NOT installed automatically — a mock register is imported on demand, from the setup walkthrough or `occ openregister:descriptors:list --app=launchpad --import=<slug>`."
"description": "Demo data for launchpad. It is not installed automatically: a mock register is imported on demand, from the setup walkthrough or `occ openregister:descriptors:list --app=launchpad --import=<slug>`."
},
"paths": {},
"components": {
Expand All @@ -17,7 +17,7 @@
"slug": "launchpad",
"title": "LaunchPad Register (demo)",
"version": "1.0.1",
"description": "Demo data for LaunchPad Register. Generated from the register's own schemas — see hydra-gates/scripts/lib/generate_mock_register.py."
"description": "Demo data for LaunchPad Register, generated from the register's own schemas. See hydra-gates/scripts/lib/generate_mock_register.py."
}
},
"schemas": {
Expand Down Expand Up @@ -105,7 +105,7 @@
"groupId": {
"title": "Group ID",
"type": "string",
"description": "Nextcloud group ID for group_shared dashboards. Reserved value 'default' means visible to every user (REQ-DASH-012). Absent for user and admin_template dashboards — the property is not in `required`, which is how OpenRegister models optionality. A union type such as [\"string\", \"null\"] is REJECTED by the schema importer (only scalar types are accepted), and that rejection is what silently prevented this whole schema — and therefore the register's reference to it — from ever being created.",
"description": "Nextcloud group ID for group_shared dashboards. The reserved value 'default' means visible to every user. It is absent for user and admin_template dashboards: the property is not in `required`, which is how OpenRegister models optionality.",
"example": "marketing"
}
},
Expand Down Expand Up @@ -188,7 +188,7 @@
},
"slug": "welcome-to-launchpad",
"title": "Welcome to LaunchPad",
"description": "Default landing dashboard visible to every user — powered by the 'default' synthetic group (REQ-DASH-012)",
"description": "Default landing dashboard visible to every user, powered by the 'default' synthetic group",
"version": "1.0.0",
"type": "group_shared",
"groupId": "default",
Expand Down Expand Up @@ -221,7 +221,7 @@
},
"slug": "active-campaigns",
"title": "Active Campaigns",
"description": "Marketing team shared dashboard — scoped to the 'marketing' group (REQ-DASH-011)",
"description": "Marketing team shared dashboard, scoped to the 'marketing' group",
"version": "1.0.0",
"type": "group_shared",
"groupId": "marketing",
Expand Down Expand Up @@ -262,7 +262,7 @@
},
"slug": "sprint-overview",
"title": "Sprint Overview",
"description": "Engineering team shared dashboard — scoped to the 'engineering' group (REQ-DASH-011)",
"description": "Engineering team shared dashboard, scoped to the 'engineering' group",
"version": "1.0.0",
"type": "group_shared",
"groupId": "engineering",
Expand Down
10 changes: 5 additions & 5 deletions lib/Settings/launchpad_register.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"slug": "launchpad",
"title": "LaunchPad Register",
"version": "1.0.1",
"description": "LaunchPad dashboards stored as OpenRegister objects — the source of the v2 runtime manifest (ADR-036 Decision 8).",
"description": "LaunchPad dashboards stored as OpenRegister objects. They are the source of the v2 runtime manifest.",
"published": true,
"schemas": ["dashboard"],
"folder": "LaunchPad"
Expand Down Expand Up @@ -106,7 +106,7 @@
"groupId": {
"title": "Group ID",
"type": "string",
"description": "Nextcloud group ID for group_shared dashboards. Reserved value 'default' means visible to every user (REQ-DASH-012). Absent for user and admin_template dashboards — the property is not in `required`, which is how OpenRegister models optionality. A union type such as [\"string\", \"null\"] is REJECTED by the schema importer (only scalar types are accepted), and that rejection is what silently prevented this whole schema — and therefore the register's reference to it — from ever being created.",
"description": "Nextcloud group ID for group_shared dashboards. The reserved value 'default' means visible to every user. It is absent for user and admin_template dashboards: the property is not in `required`, which is how OpenRegister models optionality.",
"example": "marketing"
}
},
Expand Down Expand Up @@ -189,7 +189,7 @@
},
"slug": "welcome-to-launchpad",
"title": "Welcome to LaunchPad",
"description": "Default landing dashboard visible to every user — powered by the 'default' synthetic group (REQ-DASH-012)",
"description": "Default landing dashboard visible to every user, powered by the 'default' synthetic group",
"version": "1.0.0",
"type": "group_shared",
"groupId": "default",
Expand Down Expand Up @@ -222,7 +222,7 @@
},
"slug": "active-campaigns",
"title": "Active Campaigns",
"description": "Marketing team shared dashboard — scoped to the 'marketing' group (REQ-DASH-011)",
"description": "Marketing team shared dashboard, scoped to the 'marketing' group",
"version": "1.0.0",
"type": "group_shared",
"groupId": "marketing",
Expand Down Expand Up @@ -263,7 +263,7 @@
},
"slug": "sprint-overview",
"title": "Sprint Overview",
"description": "Engineering team shared dashboard — scoped to the 'engineering' group (REQ-DASH-011)",
"description": "Engineering team shared dashboard, scoped to the 'engineering' group",
"version": "1.0.0",
"type": "group_shared",
"groupId": "engineering",
Expand Down
Loading