Shiny Docs, Happy Users #803

New issue

2023-09-07T10:51:44Z

vyzo commented

2023-09-07 10:51:44 +00:00

(Migrated from github.com)

We really want to make the documentation UX delightful for new users and experienced hackers alike.

What we need:

complete, crisp and comprehensive documentation in cons.io for the entirety of the system.
integrated gambit and standard scheme (r5rs, r75s, srfis) documentation; this is best done linking to the origin documentation at procedure granularity. it can be easily automated, just have scripts that parse the respective source documentation and generate markdown with all the relevant procedures and modules linking to the origin document.
A describe interactive form that accepts an identifier or string, searches the documentation and displays results. This should be integrated with gerbil-mode and the LSP server.
An @doc special form that can be embedded in code to emit documentation; this obviates the need for docstrings.
A custom #lang documentation prelude that allows programmers to document their code in markdown (or org-mode).

We really want to make the documentation UX delightful for new users and experienced hackers alike. What we need: - complete, crisp and comprehensive documentation in cons.io for the entirety of the system. - integrated gambit and standard scheme (r5rs, r75s, srfis) documentation; this is best done linking to the origin documentation at procedure granularity. it can be easily automated, just have scripts that parse the respective source documentation and generate markdown with all the relevant procedures and modules linking to the origin document. - A `describe` interactive form that accepts an identifier or string, searches the documentation and displays results. This should be integrated with gerbil-mode and the LSP server. - An `@doc` special form that can be embedded in code to emit documentation; this obviates the need for docstrings. - A custom `#lang` documentation prelude that allows programmers to document their code in markdown (or org-mode).

TouchstoneTheDev commented

2023-11-01 14:09:17 +00:00

(Migrated from github.com)

is this bounty available and how much is the bounty ?

vyzo commented

2023-11-01 14:16:58 +00:00

(Migrated from github.com)

if you want to help out, you can definitely share it with @drewc. DM me on gitter or email me at vyzo at hackzen.org to discuss details.

Sign in to join this conversation.