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

Add some basic usage documentation to the README #19

Open
bbatsov opened this issue Feb 23, 2018 · 5 comments
Open

Add some basic usage documentation to the README #19

bbatsov opened this issue Feb 23, 2018 · 5 comments
Labels
good first issue Good for newcomers

Comments

@bbatsov
Copy link
Member

bbatsov commented Feb 23, 2018

We should probably add a least a couple of sections regarding the high-level usage of orchard and the goals of the project.

@MalloZup
Copy link

MalloZup commented Aug 5, 2019

autogenerated with https://github.com/MalloZup/doghub: issue inactive since 450 days. Please update the issue or close it

@bbatsov bbatsov added the good first issue Good for newcomers label Dec 22, 2021
@vemv
Copy link
Member

vemv commented Jan 16, 2022

Between https://github.com/clojure-emacs/orchard#design and https://github.com/clojure-emacs/orchard#api-documentation it looks like we're well served :)

cljdoc fix is kind of in its way cljdoc/cljdoc#487

@vemv vemv closed this as completed Jan 16, 2022
@bbatsov
Copy link
Member Author

bbatsov commented Jan 16, 2022

I meant this ticket more in the sense of explaining what the various APIs are supposed to do with more prose. Something like an overview of namespaces and essential functions, but I guess good ns and function docstrings, plus working cljdoc would be a good enough solution.

Generally my concern is that few people will understand from the README how are they supposed to use Orchard.

@Cyrik
Copy link
Contributor

Cyrik commented Jan 16, 2022

I agree with @bbatsov. I was confused when I first found orchard through nrpel.
A basic overview of the namespaces plus a few usage examples would be helpful for anyone seeing this for the first time.

@vemv
Copy link
Member

vemv commented Jan 17, 2022

Alright let's see what we can do :) I agree with I guess good ns and function docstrings, plus working cljdoc would be a good enough solution., in the end Orchard is essentially a bag of defns so there's not that much to understand

@vemv vemv reopened this Jan 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants