Skip to content

hotfix(docs): publish configuration-over-code + atom-card page types to beta#332

Merged
rubenvdlinde merged 4 commits into
betafrom
hotfix/docs-config-over-code
May 22, 2026
Merged

hotfix(docs): publish configuration-over-code + atom-card page types to beta#332
rubenvdlinde merged 4 commits into
betafrom
hotfix/docs-config-over-code

Conversation

@rubenvdlinde
Copy link
Copy Markdown
Contributor

Summary

Publishes the new architecture docs to the live docs site (nextcloud-vue.conduction.nl deploys from beta). Same content merged to development in #331; this is the focused hotfix/* → beta publish.

  • New /docs/architecture/configuration-over-code/ page (OpenSpec spec-driven framing).
  • manifest.md "Page types" → atom-aware cards.
  • overview.md → cn-domain-tree hex diagrams (browser-only require, SSG-safe).
  • Sidebar position bumps; landing-page AI tile.
  • Bonus: restores CnTimelineView + CnUserActionMenu to 100% JSDoc coverage.

CI note — admin merge expected

beta's Code Quality (JSDoc completeness ratchet) is pre-existing red across ~12 unrelated components (CnCopyDialog, CnDeleteDialog, CnFileManager, CnFormBuilder, CnMass*Dialog, CnNotesCard, CnSchemaFormDialog, CnTreeView, …). That debt is not introduced by this PR — this PR reduces it by 2 components. The docusaurus SSG build and branch-protection pass. Merging via admin to bypass the pre-existing ratchet failure; broader beta JSDoc cleanup tracked separately.

Test plan

  • npx docusaurus build succeeds (SSG, no HTMLElement error) — verified locally.
  • check:jsdoc: CnTimelineView 100%, CnUserActionMenu 100%.
  • Post-merge: nextcloud-vue.conduction.nl/docs/architecture/configuration-over-code resolves.

…-types

- New /docs/architecture/configuration-over-code page framing the
  manifest + schemas contract as the safe sandbox for AI agents and
  citizen developers. Links to the academy tutorial on spec-driven
  development and to conduction.nl/apps/openbuilt.
- Manifest page: "Page types" section restructured from a flat table
  into atom-aware cards (one per type), matching the AtomZones
  vocabulary used on the app-design-principles page. Each card
  shows the atom composition (present/off) plus what fills Main and
  what the Sidebar carries.
- Sidebar positions bumped: schemas-and-registers 3 -> 4,
  customization 4 -> 5, to make room for the new page at position 3.
- Landing page: 5th entry-point tile "Configuration over code" added,
  eyebrow text updated from "Four entry points" to "Five entry points".
- overview.md: replace the Mermaid 3-layer graph with three stacked
  cn-domain-tree hex diagrams (Your app / @conduction/nextcloud-vue /
  @nextcloud/vue), middle trunk in orange to mark the layer this site
  documents. Side-effect import of @conduction/docusaurus-preset/diagrams,
  wrapped in BrowserOnly for SSR safety.
- configuration-over-code.md: rewrite the "Spec-driven development"
  section around OpenSpec (the real Hydra method): humans write specs +
  ADRs, AI implements to them; org-wide vs per-app ADR tiers; the
  /opsx-explore and /opsx-apply skills; ADR-031 declarative business
  logic with n8n/Windmill via WorkflowEngineInterface; the quality +
  gatekeeping harness. Was incorrectly framed as the JSON-manifest
  authoring workflow.
The top-level `import '@conduction/docusaurus-preset/diagrams'` defined
web-component classes extending HTMLElement at module-eval during static
site generation, where HTMLElement is undefined. Drop the top-level
import; require() the diagrams module inside the BrowserOnly render
function so it only runs in the browser.
…abels/action/slot

Restores CnTimelineView and CnUserActionMenu to 100% JSDoc coverage
(part of beta's pre-existing ratchet debt). Adds the missing header
slot doc, the five pre-translated label props, the `action` event,
and the default slot.
@rubenvdlinde rubenvdlinde merged commit 473ea0b into beta May 22, 2026
2 of 3 checks passed
@rubenvdlinde rubenvdlinde deleted the hotfix/docs-config-over-code branch May 22, 2026 09:23
@github-actions
Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 1.0.0-beta.70 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant