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

Refactor the README #203

Open
quoll opened this issue Jul 20, 2021 · 2 comments
Open

Refactor the README #203

quoll opened this issue Jul 20, 2021 · 2 comments
Labels
documentation Documentation required for users or developers

Comments

@quoll
Copy link
Contributor

quoll commented Jul 20, 2021

A project README should contain enough to introduce a user to a project, provide a sense of the functionality, and show them how to get started using it.

For small projects, a README can serve the purpose of providing all of the documentation. Asami developed past this a long time ago, moving the documentation into the wiki. However, a lot of excessive documentation and samples are still on the front page.

We need to refactor the front page to provide introductory information, but not be so intimidating for new users. The current information is possibly fine as it is, but instead of filling up the opening page, maybe it could be moved into a tutorial page or something similar. Also, various features should use links to the appropriate parts of the wiki to provide a full explanation.

@quoll quoll added the documentation Documentation required for users or developers label Jul 20, 2021
@noprompt
Copy link
Contributor

What do you think about using the doc/ directory and leveraging cljdoc? From personal experience, this has worked out fairly well for Meander and I think it could work well for this project. Here is the cljdoc for the latest release of the library. The README, additional articles, and namespace documentation are all included.

@noprompt
Copy link
Contributor

For convenience, here you can find Meanders doc/ directory and the cljdoc configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation required for users or developers
Projects
None yet
Development

No branches or pull requests

2 participants