Skip to main content

Spec Kit Portal

This is the single map for where Spec Kit artifacts live in TraderX and how they are used for generation.

Published Sources​

The portal publishes three repository sources:

  1. Root feature packs under specs/**
  2. Root Spec Kit scaffold under .specify/**
  3. Generated runtime/doc artifacts under generated/** (ephemeral outputs)

Browse in Docusaurus​

  • Root specs catalog: /specs
  • Baseline feature pack: /specs/baseline-uncontainerized-parity
  • Docs portal homepage feature pack: /specs/docs-portal-homepage
  • State docs map (flows + architecture): /docs/spec-kit/state-docs
  • Learning guides for generated code states: /docs/learning
  • OpenAPI API Explorer (runtime): /api/docs (served by running state ingress/edge)
  • Project ADRs: /docs/adr
  • .specify constitution and templates: /specify/memory/constitution
  • Generation operator guide: /docs/spec-kit/spec-kit-generation-guide
  • Generated-state branch model: /docs/spec-kit/generated-state-branches
  • Generated-state CI policy: /docs/spec-kit/generated-state-ci
  • Live demo environment registry: /docs/spec-kit/live-environments
  • EC2 Compose host prerequisites: /docs/spec-kit/aws-ec2-compose-prerequisites
  • EC2 Kubernetes host prerequisites (planned profile): /docs/spec-kit/aws-ec2-kubernetes-prerequisites
  • Learning-path visuals: /docs/learning-paths

Homepage Contract​

The Docusaurus root route / is the TraderX reference architecture portal homepage. It replaces the former default Docusaurus homepage and the standalone new_website/traderx.html prototype.

Maintaining spec:

  • Feature pack: /specs/docs-portal-homepage
  • Contract: /specs/docs-portal-homepage/system/homepage-contract

Homepage source rules:

  • Generated state blocks are sourced from catalog/state-catalog.json.
  • Live demo blocks are sourced from catalog/live-environments.json and joined to the state catalog by stateId.
  • State cards must link to canonical specs, architecture, runtime docs, learning guides, generated code branches, and ADRs when declared in the catalog.
  • Footer source claims must distinguish catalog-backed state data from curated homepage copy.

Official GitHub Spec Kit​

There is currently no official Docusaurus plugin from GitHub Spec Kit.

Official references:

How This Repo Maps to Spec Kit​

Core alignment:

  • .specify/ initialized and active
  • numbered root feature packs under specs/NNN-*
  • spec.md -> plan.md -> tasks.md flow in baseline pack
  • constitution and templates in active use
  • CI/root gates for feature-pack and branch/feature resolution checks

Repo-specific extensions:

  • manifest-driven synthesis compiler and component generators
  • conformance packs and semantic compare harness
  • parity smoke-test gates for runtime validation
  • optional learn community extension for richer learning-material authoring workflows

These extensions are intentional and sit on top of, not instead of, the core Spec Kit workflow.