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.

Sign up for GitHub

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

Jump to bottom

Proper documentation #109

Open

countvajhula opened this issue Mar 31, 2023 · 0 comments

Collaborator

countvajhula commented Mar 31, 2023 •

edited

Loading

At the moment, Symex doesn't have a single repository of documentation. There's:

the README which contains some basic information, configuration, and tips, and a keybinding table
the DSL-Docs.rst file which contains basic documentation for the DSL
the Animated Guide which functions as a visual introduction and tutorial

It would be great to have:

integrated and thorough documentation located at a definitive source (e.g. Emacs's Info system)
an interactive tutorial (eventually)
developer documentation, including Git collaboration workflows (e.g. capturing things like this comment)

countvajhula added this to Symex 2.0

countvajhula converted this from a draft issue

countvajhula moved this to In Progress in Symex 2.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment