Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co

## Repository Purpose

Documentation repository for the Keylime Monitoring Dashboard project. Contains LaTeX/Beamer presentations, the formal SRS (Software Requirements Specification), and the SDD (Software Design Description). Licensed under CC BY-SA 4.0.
Documentation repository for the Keylime Monitoring Dashboard project. Contains LaTeX/Beamer presentations. The formal SRS and SDD have moved to [keylime-webtool/spec](https://github.com/keylime-webtool/spec). Licensed under CC BY-SA 4.0.

## Build Commands

Expand Down Expand Up @@ -44,9 +44,7 @@ git config core.hooksPath .githooks

## Repository Structure

- **`spec/`** — Formal specifications:
- `SRS-Keylime-Monitoring-Tool.md` — 70 FRs, 23 NFRs, 29 SRs with Gherkin acceptance criteria and implementation refinements (Section 7)
- `SDD-Keylime-Monitoring-Tool.md` — IEEE 1016-2009 design description covering architecture, data models, API contracts, and state machines
- **`spec/`** — Redirect to [keylime-webtool/spec](https://github.com/keylime-webtool/spec) where the SRS and SDD now live
- **`slides/`** — LaTeX/Beamer presentations, each in a date-prefixed directory with numbered `.tex` files (`000-` is the main document that `\include`s the rest)
- **`slides/beamerthemeRedHat.sty`** — Shared Red Hat Beamer theme (symlinked from each presentation directory)
- **`slides/fonts/`** — Red Hat Display font family (shared, symlinked)
Expand All @@ -61,7 +59,4 @@ git config core.hooksPath .githooks

## Spec Conventions

- Requirements use tags: `FR-NNN` (functional), `NFR-NNN` (non-functional), `SR-NNN` (security)
- RFC 2119 keywords (MUST, SHALL, SHOULD, MAY) indicate requirement levels
- Acceptance criteria use Gherkin `Given/When/Then` syntax
- Section 7 of the SRS tracks implementation refinements (data models, API contracts, enumerations) that emerged during development
The SRS and SDD now live in [keylime-webtool/spec](https://github.com/keylime-webtool/spec). Refer to that repository's CLAUDE.md for spec conventions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,8 @@ Documentation and presentation slides for the Keylime Web Tool project.

## Specifications

The `spec/` directory contains the formal requirements and review documents for the project:

| Document | Description |
|----------|-------------|
| `spec/SRS-Keylime-Monitoring-Tool.md` | Software Requirements Specification (SRS) covering 70 functional, 23 non-functional, and 29 security requirements with Gherkin acceptance criteria. Includes implementation refinements (Section 7) tracking data models, API contracts, and enumerations that emerged during development. |
The formal specifications (SRS and SDD) have moved to their own repository:
**<https://github.com/keylime-webtool/spec>**

## Building

Expand Down
13 changes: 13 additions & 0 deletions spec/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Specifications

The formal specifications for the Keylime Monitoring Dashboard have moved to
their own repository:

**<https://github.com/keylime-webtool/spec>**

That repository contains:

- **SRS** (Software Requirements Specification) -- 70 FRs, 23 NFRs, 29 SRs
with Gherkin acceptance criteria
- **SDD** (Software Design Description) -- IEEE 1016-2009 design description
covering architecture, data models, API contracts, and state machines
Loading
Loading