Sitelet https://github.com/ForgeMechanic/JSONKit/tree/main/docs
Skip to content

Latest commit

 

History

History

README.md

Documentation Lifecycle Index

Last updated: 2026-02-22

This index defines the long-term doc set and lifecycle state for each document class.

Lifecycle Statuses

  • active: maintained and current; includes normative specs and current operational references.
  • reference: maintained historical/context summaries for contributor orientation.
  • archive: frozen point-in-time records kept for traceability.

Active Specifications (Normative)

  • ../architecture.md (active)
  • ../testplan.md (active)
  • ../testfilegen.md (active)
  • ../go-surface.md (active)

Read Order (v1 Contributors)

Start with the architecture and surface design for context, then reference-level docs:

  1. ../architecture.md — core invariants, layer responsibilities, LSP/embedded use cases
  2. ../go-surface.md — stability ladder, package layout, export strategy
  3. retention-modes-api.md — retention mode selection and trade-offs
  4. use-cases-performance.md — performance-oriented use cases
  5. benchmarking-json.md — cross-library benchmark harness and commands
  6. diagnostic-codes.md — complete diagnostic code inventory and contract policy

Active Long-Term Docs (Minimal Set)

  • benchmarking-json.md (active)
  • use-cases-performance.md (active)
  • retention-modes-api.md (active)
  • diagnostic-codes.md (active)

Reference Summaries

  • history-summary.md (reference hub)
  • history-api-summary.md (reference)
  • history-benchmark-summary.md (reference)

Archived Records (Frozen)

  • archive/decode-api-implementation-plan.md (archive)
  • archive/encode-api-implementation-plan.md (archive)
  • archive/embedded-json-implementation-plan.md (archive)
  • archive/stress-model-implementation-plan.md (archive)
  • archive/decode-api-benchmark-notes.md (archive)
  • archive/encode-api-benchmark-notes.md (archive)
  • archive/review-architecture-2026-02-14.md (archive)

Maintenance Rule

  • Update active docs as behavior changes.
  • Add new implementation timeline docs directly under archive/ unless they are intended to be long-term references.
  • Keep reference summary docs current when major historical milestones change.
  • Keep active docs concise and executable: prefer checklists, decision tables, and current commands over phase narrative.