artifact-app 1.0.1

Artifact is a design doc tool made for developers. It allows anyone to easily write and link their design docs both to each other and to source code, making it easy to track how complete their project is. Documents are revision controllable, can be rendered as a static web page and have a full suite of command line tools for searching, formatting and displaying them.
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# Artifact Document Specification

This document outlines the specification for the Artifact data format.
All specifications in this document are released as Creative Commons CC0
public domain. You can read more about this license here:
https://creativecommons.org/publicdomain/

## Document Type

Artifact documents adhere to a subset of the [toml][1] format and are
documents of the form:

```
[ART-baz]
partof = "ART-baa"
text = '''
multi-line
description
'''

[ART-foo-bar]
partof = "ART-baz"
text = '''
multi-line
description
'''
```

## Artifact Types

Instead of `ART` as defined in Document Type, the user must select from
3 artifact types:
- `REQ`: specifying a requirement. `REQ` can only have `REQ` in its
  `partof` field.
- `SPC`: specifying a design specification. `SPC` can only have
  `REQ` or `SPC` in its `partof` field.
- `TST`: specifying a test of a `SPC`. `TST` can only have
  `SPC` or `TST` in its `partof` field.

## Automatic Creation

The following will be automatically created:
- parents: if `REQ-foo-bar` is specified but `REQ-foo`
    does not exist then it will be created. Parents
    of all artifacts are guaranteed to exist.

## Automatic Links

The following will be automatically linked:
- parents: `REQ-foo` will automatically be a `partof`
    `REQ-foo-bar`
- common-prefix for `REQ -> SPC -> TST` links
    - `REQ-foo` will automatically be a `partof` `SPC-foo`
        *if `REQ-foo` exists*
    - `SPC-foo` will automatically be a `partof` `TST-foo`
        *if `SPC-foo` exists*

[1]: https://github.com/toml-lang/toml