@@ -0,0 +1,44 @@
1++++
2+title = "Doccord Compliant Comments in all Generators"
3+date = "2023-01-31"
4+
5+[taxonomies]
6+grant_type = ["Bounty"]
7+grant_category = ["Core Dev"]
8+
9+[extra]
10+image = ""
11+description = "Adapt the comments in the default generators to take advantage of the new doccord features."
12+reward = "1 star"
13+grant_id = "B0231"
14+completed = false
15+canceled = false
16++++
17+
18+## Overview
19+
20+The base desk comes with a variety of generators and threads that are useful for debugging and development. Documentation and usage guidance for these is scattered between inline comments (accessible via the `+help` generator) and [operators.urbit.org](https://operators.urbit.org/manual/os/dojo-tools) We propose to take advantage of the [newly released doccords](https://groups.google.com/a/urbit.org/g/dev/c/iqT0wgbFkPA) feature to consolidate the documentation and provide an introduction to the doccords utility for users.
21+
22+## Implementation
23+
24+For every "dojo tool" covered in [the docs](https://github.com/urbit/operators.urbit.org/blob/master/content/manual/os/dojo-tools.md), move the documentation into the source code in accordance with the doccord [style guide](https://github.com/urbit/urbit/blob/develop/pkg/arvo/lib/deco.hoon).
25+
26+Rewrite the `+help` generator to display the relevant doccords.
27+
28+Currently you need to do the following to see inline doccords.
29+
30+```
31+=file -build-file %/path/to/file/hoon
32+# file
33+```
34+
35+This should be improved to be:
36+
37+```
38++help %example-generator
39+> formatted comments
40+```
41+
42+## Payment
43+
44+1 Star