Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shiny Docs, Happy Users #803

Open
vyzo opened this issue Sep 7, 2023 · 2 comments
Open

Shiny Docs, Happy Users #803

vyzo opened this issue Sep 7, 2023 · 2 comments

Comments

@vyzo
Copy link
Collaborator

vyzo commented Sep 7, 2023

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
Copy link

is this bounty available and how much is the bounty ?

@vyzo
Copy link
Collaborator Author

vyzo commented Nov 1, 2023

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.

vyzo pushed a commit that referenced this issue May 21, 2024
Adding documentation for
[#803](#803).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants