Praxis Angular Docs And Playgrounds
Use this skill when a Praxis contract must be published as documentation, recipe, example, playground, or landing experience. These are derived evidence surfaces. They explain and demonstrate what the canonical owner already publishes; they do not invent runtime semantics, backend rules, AI routes, or business behavior.
Classify The Publication Change
Classify before editing:
docs-apenas: editorial or explanatory change with no public runtime/config/metadata contract change.
local-pequena: one library document, manifest item, recipe, or demo with no cross-project projection.
transversal: source library plus AI registry, docs shell, landing, public guide, recipe, or example consumer.
contrato-publico: public API/config/schema/action/capability/manifest/host integration claim or published route changes.
arquitetural: documentation exposes an unclear owner or a contradiction between Angular, metadata starter, config starter, Quickstart, or landing.
For every non-editorial claim, identify the canonical source, executable evidence, affected projection chain, intended audience, and minimum validation before writing copy.
Canonical Sources And Projection Chain
Keep these roles distinct:
praxis-ui-angular owns component runtime, public APIs, component docs, manifests, examples, recipes, playground source, and AI registry extraction.
praxis-metadata-starter owns backend x-ui, filtered schemas, actions, surfaces, capabilities, option sources, and discovery semantics.
praxis-config-starter owns persisted config, AI/context/authoring, domain decisions, ETag, and governed materialization lifecycle.
praxis-api-quickstart proves those contracts in a real host.
praxis-ui-landing-page projects library documentation into public routes; it never overrides the owning library.
The canonical docs flow is:
library source/runtime/spec -> README/API/host/editor docs -> docs manifest -> landing vendor sync -> generated component docs/published-guide registries -> route links and sitemap.
When any step disagrees, repair the canonical owner or record the drift. Do not alter a landing sentence, generated vendor file, screenshot, or recipe merely to conceal an incorrect contract.
Required Inventory
Read praxis-ui-angular/AGENTS.md, codex-rules.md, the owning library AGENTS.md, README.md, src/public-api.ts, relevant component/manifest/spec, and docs/praxis-docs.manifest.json. For component landing work, read:
docs/component-documentation-contract.md and docs/component-documentation-matrix.md;
docs/templates/component-landing-template.md and docs/templates/README.md;
praxis-ui-landing-page/AGENTS.md, component-docs.registry.ts, and landing-docs.registry.ts.
For AI-authorable behavior, inspect the manifest, ComponentDocMeta, registry tooling, and the component's recipe specs. For a backend-derived claim, inspect the corresponding metadata/config/Quickstart owner and its HTTP or focused test evidence before documenting it.
Documentation Contract
Every public component surface has a deliberate role:
| Surface |
Must establish |
| overview |
what Praxis materializes, why it differs from a basic widget, host boundary, and real value |
| API |
public inputs/outputs/events/config, precedence, defaults, constraints, and breaking behavior |
| examples |
executable or copyable proof of a valuable scenario, not decorative rendering |
| host integration |
required providers, persistence, authorization, backend/metadata/config responsibilities |
| editor |
runtime/config to visual-authoring parity, supported fields, apply/save/reset/reopen limits |
| AI |
capabilities, context, grounding, safety limits, authoring/apply boundary, and evidence |
| styles |
tokens, theming, density, and safe customization limits |
| architecture/troubleshooting |
owner decisions, failure signatures, and canonical correction path |
docs/praxis-docs.manifest.json records the owner, source paths, publication type, canonicality, routes, and automation. Only docs-shell or component-route content becomes a docs-shell surface. published-guide remains a supplemental public guide; source-only is evidence, not a promise to render a public tab. Never promote an empty, unverified, or source-only artifact to a public component claim.
Writing And Claim Rules
Write for a technical buyer, product decision maker, or implementer: value, contract, host responsibility, evidence, and limit. Do not write production instructions, private implementation checklists, or marketing claims unsupported by code, manifest, runtime, metadata, spec, or host proof.
Describe Angular components as governed, metadata-driven runtime surfaces. Preserve these boundaries:
- schemas,
x-ui, actions, surfaces, capabilities, option sources, and resource identity come from metadata contracts;
- config/AI/domain decisions are authored and persisted at the config boundary;
- Angular materializes those contracts and does not become a primary business-rule or intent-routing owner;
- host business labels/content remain metadata/config values, not library prose or i18n defaults.
Do not route user intent through labels, route fragments, aliases, regexes, or prompt phrases in examples or recipes. Use canonical component/resource/action/capability identifiers and backend-governed semantics. A recipe demonstrates declared capabilities; it does not authorize arbitrary JSON or a local frontend command parser.
Examples, Recipes, And Playgrounds
An example or recipe must be tied to a canonical source and focused spec. It should declare setup, required host/backend context, expected materialized outcome, limitations, and the smallest reproducible flow. Update its importing recipe spec when its payload/contract changes.
For visual or interactive playgrounds, prove the actual behavior in the owning runtime and, when relevant, the editor round trip. Use official routes/origins/ports and existing E2E lanes; do not create a parallel demo server or mock away a metadata/config/AI contract that the public example claims to exercise. Validate desktop and narrow viewports when the change affects visible composition, content fit, accessibility, or authoring.
Generated artifacts under dist/, vendored landing copies, generated registry output, and package assets are never hand-edited. Regenerate/synchronize through the owning script.
When a published README links to source-only evidence, verify both target existence and audience access. A canonical repository URL is a public link only if consumers can open it without repository membership; authenticated GitHub access and structural link gates do not prove this. Prefer an existing published guide for consumer-facing contracts. Keep private test reports in internal closure documentation, or label maintainer-only references explicitly instead of presenting them as public navigation. Correct the owning README and regenerate vendor docs; do not invent a public route for an internal test report.
npm Discovery Links
For npm README discovery work, inspect docs/public-links.manifest.json and each
package's docs manifest before changing links. A commercial homepage and a
technical overview serve different purposes; their URLs differing does not
establish drift. Preserve deliberate commercial links and derive technical
navigation from explicit public manifest routes, excluding source-only
surfaces. Reuse the public Angular catalog rather than maintaining a second
package inventory in READMEs. Validate generated sections and the packaged
README, including preservation through frontmatter removal.
A repository README change does not update the npm package page until a new
package version is published. Before a documentation-driven release, compare
main with the current public tag: unrelated runtime or breaking changes become
part of the same release train. Record that scope and its validation requirements;
do not represent the release as documentation-only or infer authorization for
unrelated functional publication. Keep source integration, npm publication and
landing vendor synchronization as separate delivery states.
Derived Artifact Decision Matrix
| Changed canonical surface |
Review/update |
| public API, config shape, default, event, provider |
README/API, manifest, examples, host/editor docs, consumer/landing claims |
ComponentDocMeta, authoring manifest, AI capability/operation/context |
manifest specs, examples/ai-recipes, registry ingestion, AI docs, playground/assistant evidence |
| metadata/schema/action/surface/capability/option source |
owner docs/HTTP evidence first, then Angular guides/examples that consume it |
| runtime/editor persistence or visible authoring |
editor docs, screenshots/playground, apply/save/reset/reopen proof |
| docs manifest/source path/publication/route |
landing vendor sync, component/published-guide registries, links, sitemap |
| i18n or visible copy |
docs/screenshots/examples that quote it plus i18n coverage |
| package/release claim |
package docs, public links, npm/landing claims, release validation |
When nothing changes, record negative evidence: no public behavior/manifest/metadata/config changed, no example or public claim references it, no recipe/registry source changed, no visible copy changed, and no landing/sitemap/package surface is affected.
Validation
Run the smallest official gate that proves the affected projection:
| Scope |
Minimum validation |
| changed governed Angular docs |
npm run docs:validate-frontmatter:changed |
| changed publishable docs/assets |
npm run validate:published-doc-assets |
| component docs/metadata/AI registry projection |
focused manifest/recipe specs plus npm run generate:registry:ingestion |
| changed library example/playground |
owning lib build/spec and focused browser/E2E proof when interactive |
| docs manifest intended for landing |
in landing: npm run vendor-docs:sync, then npm run validate:vendor-docs and npm run docs:validate |
| landing guide/route publication |
npm run validate:published-guides and npm run validate:sitemap; run npm run sitemap:sync only when intentional route drift requires it |
landing site.data.ts table manifests/examples |
npm run validate:table-manifests |
| broad landing projection |
npm run check:integration after focused validation is green |
Use praxis-angular-validation-gates for Node environment and build/test selection. For landing-to-Quickstart validation, use the documented 4301 origin (localhost or 127.0.0.1), not an improvised port. State exactly what browser, registry, vendor sync, landing, or hosted proof did not run.
Follow-up And Reporting
If docs reveal behavior that has no canonical source or executable evidence, classify it. Improve an existing projection for ja-suportado-*; record a platform issue only for lacuna-real-de-contrato, naming owner, consumers, public artifacts, and proof. Do not create a new component/package solely because documentation needs a category: Filters and Timeline are existing capabilities, not pretexts for parallel packages.
Report canonical owner/evidence, source documents/manifests, derived artifacts updated or reviewed, commands run, generated artifacts not hand-edited, publication status, and remaining drift or unvalidated visual/host risk.
Companion Skills
Use praxis-landing-dynamic-page-studio for the public Studio product, runtime-profile policy, curated journeys, and hosted evidence.
Use praxis-landing-public-docs-contracts and praxis-landing-registries-sitemap-playgrounds for public landing projection.
Use praxis-angular-validation-gates, praxis-angular-public-api-governance, and praxis-angular-i18n-governance for underlying contract gates.
Use praxis-ai-authoring-manifests and praxis-ai-registry-ingestion for AI-derived docs and recipes.
Use praxis-authoring-editors, praxis-ui-product-design, and the functional component skill for runtime/editor/visual proof.
Use metadata/config/quickstart skills when the documentation claim derives from those canonical owners.
1---2name: praxis-angular-docs-playgrounds3description: "Use when implementing, auditing, synchronizing, or validating Praxis Angular public documentation and derived experiences: library README/json-api/host/editor docs, docs/praxis-docs.manifest.json, docs shell and vendor sync, component/published-guide registries, examples, AI recipes, playground/demo routes, screenshots, landing pages, sitemap, LLM/public guide artifacts, or documentation-contract drift."4metadata:5 source: https://skillmd.com/skills/codexrodrigues/praxis-angular-docs-playgrounds6---78# Praxis Angular Docs And Playgrounds910Use this skill when a Praxis contract must be published as documentation, recipe, example, playground, or landing experience. These are derived evidence surfaces. They explain and demonstrate what the canonical owner already publishes; they do not invent runtime semantics, backend rules, AI routes, or business behavior.1112## Classify The Publication Change1314Classify before editing:1516- `docs-apenas`: editorial or explanatory change with no public runtime/config/metadata contract change.17- `local-pequena`: one library document, manifest item, recipe, or demo with no cross-project projection.18- `transversal`: source library plus AI registry, docs shell, landing, public guide, recipe, or example consumer.19- `contrato-publico`: public API/config/schema/action/capability/manifest/host integration claim or published route changes.20- `arquitetural`: documentation exposes an unclear owner or a contradiction between Angular, metadata starter, config starter, Quickstart, or landing.2122For every non-editorial claim, identify the canonical source, executable evidence, affected projection chain, intended audience, and minimum validation before writing copy.2324## Canonical Sources And Projection Chain2526Keep these roles distinct:2728- `praxis-ui-angular` owns component runtime, public APIs, component docs, manifests, examples, recipes, playground source, and AI registry extraction.29- `praxis-metadata-starter` owns backend `x-ui`, filtered schemas, actions, surfaces, capabilities, option sources, and discovery semantics.30- `praxis-config-starter` owns persisted config, AI/context/authoring, domain decisions, ETag, and governed materialization lifecycle.31- `praxis-api-quickstart` proves those contracts in a real host.32- `praxis-ui-landing-page` projects library documentation into public routes; it never overrides the owning library.3334The canonical docs flow is:3536`library source/runtime/spec -> README/API/host/editor docs -> docs manifest -> landing vendor sync -> generated component docs/published-guide registries -> route links and sitemap`.3738When any step disagrees, repair the canonical owner or record the drift. Do not alter a landing sentence, generated vendor file, screenshot, or recipe merely to conceal an incorrect contract.3940## Required Inventory4142Read `praxis-ui-angular/AGENTS.md`, `codex-rules.md`, the owning library `AGENTS.md`, `README.md`, `src/public-api.ts`, relevant component/manifest/spec, and `docs/praxis-docs.manifest.json`. For component landing work, read:4344- `docs/component-documentation-contract.md` and `docs/component-documentation-matrix.md`;45- `docs/templates/component-landing-template.md` and `docs/templates/README.md`;46- `praxis-ui-landing-page/AGENTS.md`, `component-docs.registry.ts`, and `landing-docs.registry.ts`.4748For AI-authorable behavior, inspect the manifest, `ComponentDocMeta`, registry tooling, and the component's recipe specs. For a backend-derived claim, inspect the corresponding metadata/config/Quickstart owner and its HTTP or focused test evidence before documenting it.4950## Documentation Contract5152Every public component surface has a deliberate role:5354| Surface | Must establish |55| --- | --- |56| overview | what Praxis materializes, why it differs from a basic widget, host boundary, and real value |57| API | public inputs/outputs/events/config, precedence, defaults, constraints, and breaking behavior |58| examples | executable or copyable proof of a valuable scenario, not decorative rendering |59| host integration | required providers, persistence, authorization, backend/metadata/config responsibilities |60| editor | runtime/config to visual-authoring parity, supported fields, apply/save/reset/reopen limits |61| AI | capabilities, context, grounding, safety limits, authoring/apply boundary, and evidence |62| styles | tokens, theming, density, and safe customization limits |63| architecture/troubleshooting | owner decisions, failure signatures, and canonical correction path |6465`docs/praxis-docs.manifest.json` records the owner, source paths, publication type, canonicality, routes, and automation. Only `docs-shell` or `component-route` content becomes a docs-shell surface. `published-guide` remains a supplemental public guide; `source-only` is evidence, not a promise to render a public tab. Never promote an empty, unverified, or source-only artifact to a public component claim.6667## Writing And Claim Rules6869Write for a technical buyer, product decision maker, or implementer: value, contract, host responsibility, evidence, and limit. Do not write production instructions, private implementation checklists, or marketing claims unsupported by code, manifest, runtime, metadata, spec, or host proof.7071Describe Angular components as governed, metadata-driven runtime surfaces. Preserve these boundaries:7273- schemas, `x-ui`, actions, surfaces, capabilities, option sources, and resource identity come from metadata contracts;74- config/AI/domain decisions are authored and persisted at the config boundary;75- Angular materializes those contracts and does not become a primary business-rule or intent-routing owner;76- host business labels/content remain metadata/config values, not library prose or i18n defaults.7778Do not route user intent through labels, route fragments, aliases, regexes, or prompt phrases in examples or recipes. Use canonical component/resource/action/capability identifiers and backend-governed semantics. A recipe demonstrates declared capabilities; it does not authorize arbitrary JSON or a local frontend command parser.7980## Examples, Recipes, And Playgrounds8182An example or recipe must be tied to a canonical source and focused spec. It should declare setup, required host/backend context, expected materialized outcome, limitations, and the smallest reproducible flow. Update its importing recipe spec when its payload/contract changes.8384For visual or interactive playgrounds, prove the actual behavior in the owning runtime and, when relevant, the editor round trip. Use official routes/origins/ports and existing E2E lanes; do not create a parallel demo server or mock away a metadata/config/AI contract that the public example claims to exercise. Validate desktop and narrow viewports when the change affects visible composition, content fit, accessibility, or authoring.8586Generated artifacts under `dist/`, vendored landing copies, generated registry output, and package assets are never hand-edited. Regenerate/synchronize through the owning script.8788When a published README links to source-only evidence, verify both target existence and audience access. A canonical repository URL is a public link only if consumers can open it without repository membership; authenticated GitHub access and structural link gates do not prove this. Prefer an existing published guide for consumer-facing contracts. Keep private test reports in internal closure documentation, or label maintainer-only references explicitly instead of presenting them as public navigation. Correct the owning README and regenerate vendor docs; do not invent a public route for an internal test report.8990## npm Discovery Links9192For npm README discovery work, inspect `docs/public-links.manifest.json` and each93package's docs manifest before changing links. A commercial homepage and a94technical overview serve different purposes; their URLs differing does not95establish drift. Preserve deliberate commercial links and derive technical96navigation from explicit public manifest routes, excluding `source-only`97surfaces. Reuse the public Angular catalog rather than maintaining a second98package inventory in READMEs. Validate generated sections and the packaged99README, including preservation through frontmatter removal.100101A repository README change does not update the npm package page until a new102package version is published. Before a documentation-driven release, compare103`main` with the current public tag: unrelated runtime or breaking changes become104part of the same release train. Record that scope and its validation requirements;105do not represent the release as documentation-only or infer authorization for106unrelated functional publication. Keep source integration, npm publication and107landing vendor synchronization as separate delivery states.108109## Derived Artifact Decision Matrix110111| Changed canonical surface | Review/update |112| --- | --- |113| public API, config shape, default, event, provider | README/API, manifest, examples, host/editor docs, consumer/landing claims |114| `ComponentDocMeta`, authoring manifest, AI capability/operation/context | manifest specs, `examples/ai-recipes`, registry ingestion, AI docs, playground/assistant evidence |115| metadata/schema/action/surface/capability/option source | owner docs/HTTP evidence first, then Angular guides/examples that consume it |116| runtime/editor persistence or visible authoring | editor docs, screenshots/playground, apply/save/reset/reopen proof |117| docs manifest/source path/publication/route | landing vendor sync, component/published-guide registries, links, sitemap |118| i18n or visible copy | docs/screenshots/examples that quote it plus i18n coverage |119| package/release claim | package docs, public links, npm/landing claims, release validation |120121When nothing changes, record negative evidence: no public behavior/manifest/metadata/config changed, no example or public claim references it, no recipe/registry source changed, no visible copy changed, and no landing/sitemap/package surface is affected.122123## Validation124125Run the smallest official gate that proves the affected projection:126127| Scope | Minimum validation |128| --- | --- |129| changed governed Angular docs | `npm run docs:validate-frontmatter:changed` |130| changed publishable docs/assets | `npm run validate:published-doc-assets` |131| component docs/metadata/AI registry projection | focused manifest/recipe specs plus `npm run generate:registry:ingestion` |132| changed library example/playground | owning lib build/spec and focused browser/E2E proof when interactive |133| docs manifest intended for landing | in landing: `npm run vendor-docs:sync`, then `npm run validate:vendor-docs` and `npm run docs:validate` |134| landing guide/route publication | `npm run validate:published-guides` and `npm run validate:sitemap`; run `npm run sitemap:sync` only when intentional route drift requires it |135| landing `site.data.ts` table manifests/examples | `npm run validate:table-manifests` |136| broad landing projection | `npm run check:integration` after focused validation is green |137138Use `praxis-angular-validation-gates` for Node environment and build/test selection. For landing-to-Quickstart validation, use the documented `4301` origin (`localhost` or `127.0.0.1`), not an improvised port. State exactly what browser, registry, vendor sync, landing, or hosted proof did not run.139140## Follow-up And Reporting141142If docs reveal behavior that has no canonical source or executable evidence, classify it. Improve an existing projection for `ja-suportado-*`; record a platform issue only for `lacuna-real-de-contrato`, naming owner, consumers, public artifacts, and proof. Do not create a new component/package solely because documentation needs a category: Filters and Timeline are existing capabilities, not pretexts for parallel packages.143144Report canonical owner/evidence, source documents/manifests, derived artifacts updated or reviewed, commands run, generated artifacts not hand-edited, publication status, and remaining drift or unvalidated visual/host risk.145146## Companion Skills147148- Use `praxis-landing-dynamic-page-studio` for the public Studio product, runtime-profile policy, curated journeys, and hosted evidence.149150- Use `praxis-landing-public-docs-contracts` and `praxis-landing-registries-sitemap-playgrounds` for public landing projection.151- Use `praxis-angular-validation-gates`, `praxis-angular-public-api-governance`, and `praxis-angular-i18n-governance` for underlying contract gates.152- Use `praxis-ai-authoring-manifests` and `praxis-ai-registry-ingestion` for AI-derived docs and recipes.153- Use `praxis-authoring-editors`, `praxis-ui-product-design`, and the functional component skill for runtime/editor/visual proof.154- Use metadata/config/quickstart skills when the documentation claim derives from those canonical owners.