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.

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

Project standalone documentation #84

Open
pilosus opened this issue Sep 4, 2021 · 0 comments
Open

Project standalone documentation #84

pilosus opened this issue Sep 4, 2021 · 0 comments
Assignees
@pilosus
Labels
documentation Improvements or additions to documentation low priority

Comments

@pilosus
Copy link
Owner

pilosus commented Sep 4, 2021 •
edited
Loading

As the project gets bigger, so does the README. It's hard to navigate now.
Although getting help from lein run --help is a nice way to look up options available, cannot cover all the topics not necessarily about the tool but probably related to how the tool is to be run in certain scenarios.
cljdoc is a nice autodoc for the library uploaded to the Clojars, yet it suffers from the same limitations as the embedded help.

All in all, a standalone website with the documentation is needed to cover:

  • tool's basic help
  • library's autodoc
  • articles related to the tool's topic of interest (license types, what real-life scenarios require attention to what types of licenses, etc.)

The platforms for hosting static web pages to consider:
@pilosus pilosus self-assigned this Sep 4, 2021
@pilosus pilosus added the documentation Improvements or additions to documentation label Sep 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pilosus pilosus

Labels
documentation Improvements or additions to documentation low priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pilosus