qalma-architecture

Stars9

Forks0

UpdatedJune 10, 2026 at 21:37

Guide architecture and product decisions for the Qalma repository. Use when discussing or changing the editor vision, public API, headless composition model, ProseMirror boundary, repository or library structure, plugin boundaries, scalability, roadmap, or a substantial refactor.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Source

cdskill

cdskill/qalma

View GitHub Repository View Creator Repositories

Download

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

File Explorer

4 files

SKILL.md

readonly

name	qalma-architecture
description	Guide architecture and product decisions for the Qalma repository. Use when discussing or changing the editor vision, public API, headless composition model, ProseMirror boundary, repository or library structure, plugin boundaries, scalability, roadmap, or a substantial refactor.

Qalma Architecture

Protect the product direction while evolving the repository from its current small foundation. Base decisions on the code that exists today and introduce boundaries only when they solve a demonstrated problem.

Start With Context

Read product-vision.md for positioning, product principles, anti-goals, and roadmap.
Read current-architecture.md before deciding where code belongs or changing a public contract.
Inspect the relevant source files. Treat the references as durable intent, not a substitute for current repository state.

Make An Architecture Decision

Classify the capability as core runtime, first-party plugin, Angular UI primitive, consumer UI, or tooling.
Preserve the headless composition model and the ProseMirror abstraction boundary.
Design the smallest coherent Angular-facing public API first.
Keep implementation-specific helpers private unless consumers need them.
Place the capability in the current editor library unless a concrete split criterion from current-architecture.md is met.
Explain the chosen boundary, rejected alternatives, tradeoffs, and the condition that would justify revisiting it.
Implement only the current evolutionary step when implementation is requested. Do not scaffold a speculative final monorepo.
Update the relevant architecture reference when the implemented decision changes durable repository intent or current structure.

Preserve These Properties

Angular-native and signal-first developer experience.
Headless core with consumer-owned templates and styling.
Typed, composable, independently selectable plugins.
Stable Qalma contracts over raw ProseMirror contracts.
Accessible behavior and observable command state.
Small intentional public API and low mandatory bundle cost.
Sandbox as executable consumer documentation.

Coordinate With Plugin Work

Use qalma-plugin-development when an architectural decision becomes a plugin implementation. Return here if that plugin requires a new extension point, public contract, or library boundary.

More from this repository

same repository

qalma

cdskill/qalma

Use when building with Qalma, the Angular-first headless rich text editor. Covers installing @qalma/editor, composing Angular UI around Qalma primitives (or adopting the optional @qalma/kit component layer for ready-made toolbar, menus, and popovers), selecting and configuring first-party plugins, authoring custom Qalma plugins, migrating from another editor, debugging editor behavior, or contributing to the Qalma repository.

2026-07-099

qalma-release

cdskill/qalma

Guide npm releases and the publish pipeline for @qalma/editor and @qalma/skills. Use when discussing or changing versioning, the release scripts, the GitHub Actions release workflow, the Nx release configuration, npm publishConfig, or npm Trusted Publisher setup.

2026-07-079

qalma-docs-sync

cdskill/qalma

Synchronize Qalma documentation surfaces after adding, changing, renaming, or removing an editor plugin, command, query, kit, public option, sandbox/playground behavior, docs navigation entry, or public agent guidance. Use with Qalma plugin work to keep apps/docs, libs/editor/README.md, plugins/qalma, AGENTS.md, and repository skills accurate.

2026-06-289

qalma-plugin-development

cdskill/qalma

Implement, change, review, or remove Qalma editor plugins end to end. Use for requests involving a new plugin or feature, ProseMirror marks or nodes, commands, command states, keyboard shortcuts, configurable plugin options, plugin kits, toolbar integration, sandbox examples, or plugin behavior tests.

2026-06-199

git-commit

cdskill/qalma

Create well-formatted conventional commits from staged changes, with a MANDATORY scope. Use when the user invokes /git-commit, /commit, or asks to generate and create a commit for this repository.

2026-06-159

docs-deployment

cdskill/qalma

How apps/docs is hosted and shipped — SSG on AWS S3 + CloudFront, OpenTofu/Terraform infrastructure, and the nx-affected CI deploy workflow. Read before any question or change about docs hosting, the SSG hosting model, CloudFront, S3, CDN caching, the qalma.dev domain, the ACM/TLS cert, the OIDC deploy role, or the docs deploy pipeline. Avoids re-scanning the repo. Infra/ops scope only — not app-level concerns.

2026-06-139

name	qalma-architecture
description	Guide architecture and product decisions for the Qalma repository. Use when discussing or changing the editor vision, public API, headless composition model, ProseMirror boundary, repository or library structure, plugin boundaries, scalability, roadmap, or a substantial refactor.

Qalma Architecture

Start With Context

Read product-vision.md for positioning, product principles, anti-goals, and roadmap.
Read current-architecture.md before deciding where code belongs or changing a public contract.
Inspect the relevant source files. Treat the references as durable intent, not a substitute for current repository state.

Make An Architecture Decision

Classify the capability as core runtime, first-party plugin, Angular UI primitive, consumer UI, or tooling.
Preserve the headless composition model and the ProseMirror abstraction boundary.
Design the smallest coherent Angular-facing public API first.
Keep implementation-specific helpers private unless consumers need them.
Place the capability in the current editor library unless a concrete split criterion from current-architecture.md is met.
Explain the chosen boundary, rejected alternatives, tradeoffs, and the condition that would justify revisiting it.
Implement only the current evolutionary step when implementation is requested. Do not scaffold a speculative final monorepo.
Update the relevant architecture reference when the implemented decision changes durable repository intent or current structure.

Preserve These Properties

Angular-native and signal-first developer experience.
Headless core with consumer-owned templates and styling.
Typed, composable, independently selectable plugins.
Stable Qalma contracts over raw ProseMirror contracts.
Accessible behavior and observable command state.
Small intentional public API and low mandatory bundle cost.
Sandbox as executable consumer documentation.

Coordinate With Plugin Work

Use qalma-plugin-development when an architectural decision becomes a plugin implementation. Return here if that plugin requires a new extension point, public contract, or library boundary.