You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
The text was updated successfully, but these errors were encountered:
We really want to make the documentation UX delightful for new users and experienced hackers alike.
What we need:
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.@doc
special form that can be embedded in code to emit documentation; this obviates the need for docstrings.#lang
documentation prelude that allows programmers to document their code in markdown (or org-mode).The text was updated successfully, but these errors were encountered: