General
-
47 votes
-
Provide a way to create (and be able to synchronise) an offline version of this tool.
I'd love to be able to use this tool offline, i.e. when I'm in a coffee shop with no internet connection. I don't need the absolute latest version, I'm happy to sync once a week or so.
24 votes -
Support viewing the entire site as a single page.
This would allow quick reading/scanning of the entire documentation set.
12 votes -
9 votes
-
support utf-8 html encoding.
By adding a simple line to your html template, you should avoid things like these:
http://cl.ly/b9aff90955ab2e4d0a03
Example html header line:
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>8 votes -
Make search and autocomplete show same results
Type "pp" in search box, wait for autocomplete; note the options. Then press enter to execute the search. Notice that the search results differ from the autocomplete box. This is very confusing!
8 votes -
Fix syntax highlighting with double-quote
See http://clojuredocs.org/v/2927 for an example of broken syntax highlighting: \" is not recognized as a non-quote; instead, it is recognized as a quote.
7 votes -
Upgrade to SyntaxHighlighter 3.* - allows copy&paste snippet from webpage to REPL w/o line#
Latest SH 3.* selects code snippets without the line numbers, which allows one to copy&paste snippet straight into a REPL for easy testing
7 votes -
Add documentation for internal classes
Add documentation for the internal Clojure classes (e.g.: clojure.lang.PersistentVector). At least a listing of the methods would be helpful so that they can be called with (method. a-persistent-vector)
5 votes -
Fix autocomplete.
Try "line-" First result is "line-seq". Try "line-s" and "line-seq" does not appear at all. I've seen this for others.
5 votes -
Add a list of "standard" metadata attributes
Add a list of "standard" metadata attributes (`:author`, `:copyright`, `:doc`, etc.)
5 votes -
Editable doc string
HTML supports more formatting than doc strings. Var documentation could be an editable wiki, like the examples, that starts off with the doc string embedded in a <pre> block. Users would then be able to update the documentation to fix spelling errors, improve formatting, etc.
5 votes -
4 votes
-
have a glossary, and each page automatically link to glossary terms when present
Basically keep a big index of glossary terms, and then whenever a glossary term is present on a page, automatically link the term to its definition. Or, maybe better yet, have some kind of javascript-fu automatically load the definition and display it in a popup or an on-page bubble.
4 votes -
Create a "Random ClojureDoc learning page"
On main site there could be 2 more links:
- Random ClojureDocs page
- ClojureDoc of the day (or the week)That way one could daily (or maybe weekly) tune-in and learn some more random stuff just for the sake of learning. This is one use of the site where one doesn't need to know what exactly is he/she looking for. She/he just wanna learn one more thing today and maybe be surprised by some interesting new previously unknown (in the case of selected Weekly or Daily Links) feature to her/him.
4 votes -
clickable functions in example
when reading examples of a function i want to understand, it's very possible i encounter other functions i don't know off. it would be nice if i didn't have to search for the new function but just click it.
the functions in examples could be links.
or they could have a search button that appears over or near them when hovering with the mouse over the function.
either of these markers will autosubmit a search and then spawn the result list (same as the search from top right page)
4 votes -
Update source links for clojure.contrib
All source links to github on the clojure.contrib pages give a 404.
3 votes -
Signup: Bad OpenID URL leads to bad page
I inadvertently used the wrong URL (wrong domain in URL) for my Open ID when attempting to sign up. Rather than getting an error I was prompted to create a user and password, and was then taken to a blank page.
3 votes -
There should be a mechanism to let people make minor changes without altering the attribution
I've noticed that zkim went through and made minor changes to the examples that I wrote. As he made these changes, the author change to "zkim." There should be a mechanism whereby ClojureDocs decides if the change is large enough to warrant changing the author.
This could be automatic or something a person does. For instance, PmWiki has a checkbox reading "This is a minor change."
It is discouraging for someone to spend time helping the community fill out the documentation only to find their attribution removed. Worse yet, looking up documentation that you wrote and finding it attributed to… more
3 votes -
Fix the stuff missing from the quick ref, e.g. flatten
flatten is not listed in the quick ref. I think I saw some more stuff missing, but can't remember what it was. Why is this?
3 votes