You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Added
- **SpecEngine dependency content fingerprint** (`docs/specs/SpecEngine/c5fingerprint.py`): new SpecEngine module that computes per-file SHA-256 hashes over the contents of every file listed in a Doorstop item's `references:` field and stores a `references_content_fingerprint` block (combined hash + per-file breakdown) in each item's YAML frontmatter, enabling dependency-aware impact analysis across all Doorstop documents (MRS, SRS, ARC, SWD, TCS, TRP); items whose referenced files have changed since the last run are flagged as `[STALE]` and have their stored fingerprint updated in-place; supports `--dry-run` (compute only, no writes), `--check` (exit code 1 on stale, for use as a CI gate), and `--verbose` (per-file hash detail) flags; automatically registers the `references_content_fingerprint: {}` attribute default in the `.doorstop.yml` of every document that contains references-bearing items; integrated into `publish.sh` as the final step (after all undo/restore steps)
- **DocEngine standalone mode** (`c5dec docengine <type> -n <name> --standalone`): `create_docengine_template()` accepts a new `standalone` boolean argument; when set, the command additionally copies the `.devcontainer` folder, `docEngine.Dockerfile`, `poetry.lock`, and `pyproject.toml` from the repository root into the generated template destination, enabling users to open and use DocEngine directly in VS Code without the rest of the C5-DEC environment; `--standalone` flag added to the `docengine` CLI argument parser
- **End-user DocEngine manual package** (`docs/manual/docengine-manual/`): added a user-oriented manual authored as a DocEngine report template, including chapters, figures, Quarto configuration, and helper scripts, together with a compiled PDF output artifact for immediate consumption by end users
## Modified
- Migrated the DocEngine user manual from the SSDLC page to a dedicated and more detailed `docengine.md` page under `docs/manual`
- Updated manual entry README and other relevant docs to reflect the DocEngine documentation update
## Fixed
- Bug preventing the Ubuntu font from being used by DocEngine
Copy file name to clipboardExpand all lines: CHANGELOG.md
+25Lines changed: 25 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,28 @@
1
+
# 1.3 (2026-03-23)
2
+
3
+
## Added
4
+
5
+
-**SpecEngine dependency content fingerprint** (`docs/specs/SpecEngine/c5fingerprint.py`): new SpecEngine module that computes per-file SHA-256 hashes over the contents of every file listed in a Doorstop item's `references:` field and stores a `references_content_fingerprint` block (combined hash + per-file breakdown) in each item's YAML frontmatter, enabling dependency-aware impact analysis across all Doorstop documents (MRS, SRS, ARC, SWD, TCS, TRP); items whose referenced files have changed since the last run are flagged as `[STALE]` and have their stored fingerprint updated in-place; supports `--dry-run` (compute only, no writes), `--check` (exit code 1 on stale, for use as a CI gate), and `--verbose` (per-file hash detail) flags; automatically registers the `references_content_fingerprint: {}` attribute default in the `.doorstop.yml` of every document that contains references-bearing items; integrated into `publish.sh` as the final step (after all undo/restore steps)
6
+
7
+
-**DocEngine standalone mode** (`c5dec docengine <type> -n <name> --standalone`): `create_docengine_template()` accepts a new `standalone` boolean argument; when set, the command additionally copies the `.devcontainer` folder, `docEngine.Dockerfile`, `poetry.lock`, and `pyproject.toml` from the repository root into the generated template destination, enabling users to open and use DocEngine directly in VS Code without the rest of the C5-DEC environment; `--standalone` flag added to the `docengine` CLI argument parser
8
+
9
+
-**End-user DocEngine manual package** (`docs/manual/docengine-manual/`): added a user-oriented manual authored as a DocEngine report template, including chapters, figures, Quarto configuration, and helper scripts, together with a compiled PDF output artifact for immediate consumption by end users
10
+
11
+
## Modified
12
+
13
+
- Migrated the DocEngine user manual from the SSDLC page to a dedicated and more detailed `docengine.md` page under `docs/manual`
14
+
- Updated manual entry README and other relevant docs to reflect the DocEngine documentation update
15
+
16
+
## Fixed
17
+
18
+
- Bug preventing the Ubuntu font from being used by DocEngine
C5-DEC CAD is the software component of C5-DEC: an [AI-enabled](./docs/manual/ssdlc.md#ai-enabled-design-specification-development-and-testing) toolkit for secure system design, development, and evaluation across [CLI/TUI/GUI and VS Code](#usage). It combines [CCT](./docs/manual/cct.md), [SSDLC](./docs/manual/ssdlc.md) with [SpecEngine](./docs/specs/SpecEngine/README.md) and [DocEngine](./docs/manual/ssdlc.md#c5-dec-docengine-for-report-generation), [CRA](./docs/manual/cra.md), [SBOM](./docs/manual/sbom.md), [CPSSA](./docs/manual/cpssa.md), [cryptography](./docs/manual/cryptography.md), and [project management](./docs/manual/pm.md) in one traceable, open-format (Markdown/YAML) workflow.
9
+
C5-DEC CAD is the software component of C5-DEC: an [AI-enabled](./docs/manual/ssdlc.md#ai-enabled-design-specification-development-and-testing) toolkit for secure system design, development, and evaluation across [CLI/TUI/GUI and VS Code](#usage). It combines [CCT](./docs/manual/cct.md), [SSDLC](./docs/manual/ssdlc.md) with [SpecEngine](./docs/specs/SpecEngine/README.md), [DocEngine](./docs/manual/docengine.md), [CRA](./docs/manual/cra.md), [SBOM](./docs/manual/sbom.md), [CPSSA](./docs/manual/cpssa.md), [cryptography](./docs/manual/cryptography.md), and [project management](./docs/manual/pm.md) in one traceable, open-format (Markdown/YAML) workflow.
10
10
11
11
This repository contains the C5-DEC CAD source code plus full documentation, including requirements, design artifacts, the [user manual](./docs/manual/README.md), and test specifications/reports; live traceability is published on the [technical specification web site](https://abstractionslab.github.io/c5dec/traceability/index.html).
12
12
@@ -30,7 +30,7 @@ For a visual stakeholder-oriented tour of C5-DEC CAD, visit the **[product prese
30
30
31
31
## Overview
32
32
33
-
C5-DEC CAD assists system/software designers, developers, testers and security analysts with building and evaluating secure software systems. It integrates SSDLC, SVV, and CPSSA within the Common Criteria framework, providing full artifact traceability across the entire development life cycle, along with cryptographic checks, threat modelling, quantitative risk analysis, Cyber Resilience Act (CRA) compliance support, and SBOM lifecycle management. Its DocEngine, built on Quarto with custom LaTeX enhancements and pre/post-render scripting, enables smart document authoring, scientific and technical publishing across report, presentation, and CRA technical documentation templates.
33
+
C5-DEC CAD assists system/software designers, developers, testers and security analysts with building and evaluating secure software systems. It integrates SSDLC, SVV, and CPSSA within the Common Criteria framework, providing full artifact traceability across the entire development life cycle, along with cryptographic checks, threat modelling, quantitative risk analysis, Cyber Resilience Act (CRA) compliance support, and SBOM lifecycle management. Its [DocEngine](./docs/manual/docengine.md), built on Quarto with custom LaTeX enhancements and pre/post-render scripting, enables smart document authoring and scientific and technical publishing across report, presentation, and CRA technical documentation templates.
34
34
35
35
### Knowledge base
36
36
@@ -53,9 +53,8 @@ C5-DEC ships two complementary knowledge bases:
53
53
### Secure software development life cycle (SSDLC)
54
54
55
55
-[New C5-DEC project scaffolding](./docs/manual/ssdlc.md#c5-dec-project-creation) (`c5dec new`): containerized repository with dependencies, templates, DocEngine, SpecEngine, and Doorstop-based traceability, with an [AI-enabled](./docs/manual/ssdlc.md#ai-enabled-design-and-specification) approach for generating requirements, test cases, and technical reports;
56
-
-[DocEngine](./docs/manual/ssdlc.md#c5-dec-docengine-for-report-generation) (`c5dec docengine`): Quarto-based publishing pipeline with LaTeX customizations and pre/post-render scripts; scaffolds three template types — `report`, `presentation` (Reveal.js and PowerPoint with ALab branding), and `cra-tech-doc` (CRA Annex VII technical documentation);
56
+
- [SpecEngine](./docs/specs/SpecEngine/) toolkit for specification management following the [C5-DEC method](./docs/specs/README.md): `c5graph.py` (interactive Cytoscape.js traceability graph with dagre layout, expand/collapse, color-coded coverage), `c5mermaid.py` (Mermaid-to-SVG/PNG pre-processor with undo and dry-run, integrated into `publish.sh`), `c5browser.py` (standalone Bootstrap + DataTables HTML browser for Doorstop items with sortable/filterable per-document-type tables), `c5traceability.py` (configurable traceability matrix statistics with console and HTML report output, auto-discovery of document trees from `.doorstop.yml` files), `c5fingerprint.py` (dependency content fingerprinting — computes per-file SHA-256 hashes for files referenced in item `references:` lists and stores a combined digest in each item's YAML frontmatter; flags stale items when source files change, enabling dependency-aware impact analysis across the full specification tree; supports `--dry-run`, `--check` CI gate, and `--verbose` modes), `prune_bad_links.py` (Doorstop link pruning), and `doorstop_yml_to_md.py` (YAML-to-Markdown item migration);
57
57
-[Transformer](./docs/manual/ssdlc.md#transformer): document transformation and format conversion using [Doorstop](https://github.com/doorstop-dev/doorstop), [Quarto](https://github.com/quarto-dev/quarto), [pandoc](https://pandoc.org/), and [organize](https://github.com/tfeldmann/organize);
58
-
-[SpecEngine](./docs/specs/SpecEngine/) toolkit for specification management following the [C5-DEC method](./docs/specs/README.md): `c5graph.py` (interactive Cytoscape.js traceability graph with dagre layout, expand/collapse, color-coded coverage), `c5mermaid.py` (Mermaid-to-SVG/PNG pre-processor with undo and dry-run, integrated into `publish.sh`), `c5browser.py` (standalone Bootstrap + DataTables HTML browser for Doorstop items with sortable/filterable per-document-type tables), `c5traceability.py` (configurable traceability matrix statistics with console and HTML report output, auto-discovery of document trees from `.doorstop.yml` files), `prune_bad_links.py` (Doorstop link pruning), and `doorstop_yml_to_md.py` (YAML-to-Markdown item migration);
59
58
- A [KB element](#knowledge-base) dedicated to software verification and validation (SVV).
60
59
61
60
A view of the C5-DEC CAD specification browser:
@@ -70,6 +69,24 @@ A view of the C5-DEC CAD traceability statistics:
A Quarto-based document publishing engine ([full reference](./docs/manual/docengine.md)) for generating professional technical documents from Markdown source files:
75
+
76
+
- Three ready-to-use template types scaffolded by `c5dec docengine <type> -n <name>`:
77
+
-`report` — full technical report with LaTeX cover page, chapter structure, custom headers/footers, bibliography, and DOCX reference template;
78
+
-`presentation` — Reveal.js (HTML) and PowerPoint slide deck with ALab branding;
79
+
-`cra-tech-doc` — CRA Annex VII seven-chapter compliance technical documentation, also available via `c5dec cra tech-doc`;
80
+
- Supports PDF, HTML, and DOCX outputs from the same Markdown source;
81
+
- Two configuration formats: `c5dec_config.yml` (v1, plain strings) and `c5dec_config_v2.yml` (v2, structured changelog entries, automatic LaTeX escaping);
82
+
- Python pre/post-render scripts for cover page metadata injection, Doorstop-based table generation, and LaTeX file lifecycle management;
83
+
-`--standalone` flag produces a self-contained template with its own devcontainer, enabling DocEngine use outside the main C5-DEC repository;
84
+
- Integrated with the [CCT ETR generation pipeline](./docs/manual/cct.md#c5-dec-docengine-for-etr-generation) and the [CRA technical documentation workflow](./docs/manual/cra.md#2-cra-technical-documentation-generator).
0 commit comments