summaryrefslogtreecommitdiff
path: root/roadmap.mdwn
blob: cddc3e2487004aea53af9d1534ea6bb51e4ea9e5 (plain)
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[[!meta title="Road map"]]

This is the road map for the Subplot project. It does not stretch very
far, because predicting the future is difficult. This road map also
doesn't give any dates, since we do not get paid for this. We will
review the roadmap for every iteration.

```roadmap
testmuck:
  label: |
    Lars can use Subplot
    to test Muck
  depends:
    - subplot_tests_itself

subplot_tests_itself:
  status: next
  label: |
    Subplot tests itself; the input language is specified and
    there are tests to verity Subplot implements it correctly
  depends:
    - website
    - docgen
    - codegen

website:
  status: finished
  label: |
    Project website
    is updated by CI
    using Subplot Pandoc 
    filter
  depends:
    - pandoc_filter
    - subplot_deb

pandoc_filter:
  status: finished
  label: |
    Subplot provides
    a separate binary
    for use as a Pandoc
    filter
  depends:
    - docgen_roadmap

docgen:
  status: finished
  label: |
    Docgen can produce
    PDF and HTML docs
    from Md, bindings
    using Pandoc
  depends:
    - docgen_roadmap

docgen_dot:
  status: finished
  label: |
    Docgen can render
    code blocks with
    dot markup as SVG

docgen_roadmap:
  status: finished
  label: |
    Docgen can render
    code blocks with
    roadmap markup as SVG
  depends:
    - roadmap_crate
    - docgen_dot

roadmap_crate:
  status: finished
  label: |
    There is a production-ready
    crate for parsing roadmap
    markup and producing
    dot output

subplot_deb:
  status: finished
  label: |
    CI produces .deb
    packages of Subplot
  depends:
    - pandoc_filter

codegen:
  status: finished
  label: |
    Codegen can produce
    a test program in
    some language (Python
    or Rust)
```

# Roadmap legend

```roadmap
goal:
  label: |
    This is the end goal:
    if we reach here, there
    is nothing more to be
    done in the project
  depends:
  - finished
  - blocked

finished:
  status: finished
  label: |
    This task is finished;
    the arrow indicates what
    follows this task (unless
    it's blocked)

ready:
  status: ready
  label: |
    This task is ready 
    to be done: it is not
    blocked by anything

next:
  status: next
  label: |
    This task is chosen 
    to be done next

blocked:
  status: blocked
  label: |
    This task is blocked
    and can't be done until
    something happens
  depends:
  - ready
  - next
```