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

# Artifact Web UI

For an example web ui, see [artifact's own design docs][2]

The artifact Web UI is intended to be simple and intuitive, however
it can be helpful to have some context.

For more information about artifact, see it's [homepage][1]

[1]: https://github.com/vitiral/artifact
[2]: http://vitiral.github.io/artifact/#artifacts/req-1

## Artifact Color

An "artifact" is something with a name like "ART-name" where "ART" is
one of:
- `REQ`: a requirement
- `SPC`: a design specification
- `TST`: a test

Artifacts can take on different colors representing:
- green: artifact is completed and tested
- blue: artifact is completed but not tested (or partially complete and tested)
- yellow: artifact is somewhat complete/tested
- red: artifact is not very complete or tested

## List View

The base view is the List View. It contains a column selector at the top
left, a search bar at the top right, and a list of the searched artifacts
below.

### Column Selector
The column selector lets you select columns you wish to view. Displayed
columns will be black and hidden columns will be grey.

### Search Bar
The search bar allows you to search in the `name`, `parts`, `partof` and/or
`text` fields for the value in the search bar. By default it searches for
(case insensitive) text, but you can also enable regex searching with the
button to the right of the search bar.