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

giving the docs a bit more love #3

Open
RichMorin opened this issue Dec 24, 2022 · 0 comments
Open

giving the docs a bit more love #3

RichMorin opened this issue Dec 24, 2022 · 0 comments

Comments

@RichMorin
Copy link
Contributor

I'd like to give the Spec docs a bit more love, but I'm not really sure about the best way to approach this. I took a stab at README.md (see master...RichMorin:spec:patch-2), but I may well have gotten assorted things wrong. Also, I don't know if you are still interested in this project. So, let me know...

Aside from the README tweaks, I'd like to try adding some comments and documentation to the code files. Aside from clarifying the intent of the code, this could generate API docs, etc. However, this would also need your feedback and guidance. Finally, it might be really interesting and useful to create a Livebook on Spec. (ducking)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant