@@ -0,0 +1,46 @@
2+title = "Doccord Compliant Comments in all Generators"
6+grant_type = ["Bounty"]
7+grant_category = ["Core Dev"]
12+description = "Adapt the comments in the default generators to take advantage of the new doccord features."
17+work_request_link = "https://airtable.com/shr4qt9t9kz7RaOIa?prefill_Grant+ID=B0231&prefill_Grant+Name=Doccord%20Compliant%20Comments%20for%20All%20Generators"
22+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.
26+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).
28+Rewrite the `+help` generator to display the relevant doccords.
30+Currently you need to do the following to see inline doccords.
33+=file -build-file %/path/to/file/hoon
37+This should be improved to be:
40++help %example-generator