cartulary 0.3.0-alpha.1

The knowledge layer of your project — decisions, issues, docs, all in one place.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Companion files alongside an issue's `index.md`.
//!
//! Issues are stored as a directory containing a mandatory `index.md`
//! plus arbitrary companion files. The directory is the place where
//! issue-related data lives — implementation plans, design records,
//! mockups, screenshots, business documents.
//!
//! Three filenames are standardised so the CLI can render them
//! directly:
//!
//! - `plan.md` — implementation plan (living artifact, evolves with
//!   the work),
//! - `implementation-notes.md` — non-trivial technical choices,
//! - `design-decision.md` — alternatives considered and the chosen
//!   approach.
//!
//! Anything else is acknowledged as a companion (it appears in the
//! issue's listing) but its content stays opaque to the domain.

pub mod canonical;
pub mod companions;
pub mod content;
pub mod identifier;
pub mod kind;
pub mod value;

pub use canonical::{
    canonical_filename_from_stem, canonical_stems_csv, CANONICAL_FILENAMES,
    DESIGN_DECISION_FILENAME, IMPLEMENTATION_NOTES_FILENAME, PLAN_FILENAME,
};
pub use companions::IssueCompanions;
pub use content::CompanionContent;
pub use identifier::CompanionIdentifier;
pub use kind::CompanionKind;
pub use value::IssueCompanion;