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

Doc tree improvement #261

Open
kwladyka opened this issue Mar 12, 2019 · 1 comment
Open

Doc tree improvement #261

kwladyka opened this issue Mar 12, 2019 · 1 comment

Comments

@kwladyka
Copy link

As a person who see this doc very rarely:

Issue

For example I want to find solution for using namepsace in keywords for tables.
The solution which I am looking for is :qualifier (which I don't know yet).

Page where I start:
http://clojure-doc.org/articles/ecosystem/java_jdbc/home.html

Tree of the doc
image

It is very not obviously I will find the answer in "Using SQL". In practice I totally ignored this link, because it didn't look like something with interesting content. Also the tree on the left mislead me.

Solution

  1. Personally I like the idea of https://shadow-cljs.github.io/docs/UsersGuide.html where everything is on 1 page. Then it is easy to find answers by cmd+f.

Then it will be needed to add links to headers like http://clojure-doc.org/articles/ecosystem/java_jdbc/home.html#overview or something like that.

  1. If you don't like 1) add search and make tree on the left to show whole doc and where I am. Not tree for exactly this 1 page.

But personally I vote for 1) Doc maintainers don't have to care about search, different pages, it is easy and fast to jump into interesting content. There is one place of source of information.

@seancorfield
Copy link
Contributor

I'm am resurrecting this site at https://clojure-doc.github.io so feel free to recreate this issue at https://github.com/clojure-doc/clojure-doc.github.io/issues or submit a PR https://github.com/clojure-doc/clojure-doc.github.io/pulls

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

2 participants