Skip to content

Doc tree improvement #261

@kwladyka

Description

@kwladyka

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions