Documentation

Welcome to the @relational-fabric/canon documentation. This package provides modern TypeScript and ESLint configurations for starting new projects.

Getting Started

• Project Setup — Step-by-step guide to bootstrap a new project with Canon as the initial dependency

Installation

npm install @relational-fabric/canon

TypeScript Configuration

{
  "extends": "@relational-fabric/canon/tsconfig"
}

ESLint Configuration

// eslint.config.js
import createEslintConfig from '@relational-fabric/canon/eslint'

export default createEslintConfig()

Documentation Sections

• Reference - API details, axiom specifications, and integrations
• Canons - Core principles and guidelines
• Axioms - Fundamental assumptions and rules
• Examples - Practical usage examples
• Type Testing - Compile-time invariants and assertion helpers

Architecture Decisions

• ADRs - Architecture Decision Records documenting key decisions

Planning & Strategy

• Technology Radar - Technology recommendations and assessments
• Planning Overview - Strategic direction and roadmap
• Radar Methodology - Technology assessment approach

Development Notes

Build Process: The documentation build process automatically renames all README.md files to index.md within the docs directory to work with VitePress routing. This is handled by the build scripts in package.json:

• npm run build:docs renames README.md → index.md during build
• npm run build:docs:restore renames index.md → README.md for editing

When editing documentation, use npm run build:docs:restore first to convert index.md files back to README.md, make your changes, then run the build commands.