Skip to end of metadata
Go to start of metadata

The following is a list of things that could be improved at  I have been collecting these as I notice people mention them on #clojure, Twitter, mailing list, etc. I do not know what the ideal process would be for noting things to fix, providing updates, and getting them approved and applied.  I suspect they should be managed through JIRA just like bugs in the code but I will leave it to the core team to update this.  I am happy at the moment merely to get this list out of a private file and into a public list where someone else can possibly work on it.

  • Main page
    • News items at bottom of page should have dates.
  • Navigation on all pages (left and top right)
    • I think it would be great for these links to be better grouped and organized and reconsider which links go on the left and which on the top right box.
    • Top right nav
      • Upper right box "Dev" link currently goes to old assembla space instead of newer - this would be a quick fix fixed
      • I assume the top right links should all be very high-value - currently they are not.  
  • Top right nav proposal:
    • Download
    • Getting started - a link to a page with the info from the current Getting Started page, and dev clojure stuff on IDEs, build systems, etc. 
    • News/blog - (preferably more frequently updated)
    • Google group 
    • IRC
    • (Docs - this is a grouping of related links, not a link)
      • API
      • Contrib API combined autodoc (NOT the current link to github root)
      • Cheat sheet 
      • think it's critical to get the first 3 in this list on the top nav. The rest below are a judgement call as to whether they go there or left nav or on a "docs and/or learning" page.
        • Screencasts
        • Presentations (from Stu and Rich, etc)
        • See [|] for some more ideas
      • Dev -> should be a link that goes to a page that includes:
        • links to github source for core and contrib
        • link to jira
        • link to confluence
        • link to how to contribute '
        • link to creating a patch
      • Clojure/core??? No link to this right now but it seems like it would be useful to understand who's guiding the ship. 
  • Left nav 
    • Should review all existing pages to ensure they are listed on the nav or otherwise accessible.  I've recently found and surfaced the pages on types/records, protocols, and transients for example.
  • Would be great to group these left links in some way that visually leads you towards something interesting or useful. Something like:
    • About - Rationale, On State & Identity, Features/*, Differences with Lisps
    • Language - Reader, REPL and main, Evaluation, Special Forms, Metadata, Namespaces, Libs, Vars and Env
    • Functions - Macros, Other Functions, Multimethods and Hierarchies, Protocols
    • Data - Data structures, Datatypes, Sequences, Transients
    • Concurrency - Refs, Agents, Atoms
    • Java interop - Java interop, Compilation and Class Generation
    • Other libraries -  
  • [Cheat sheet|]
    • This currently starts life as a Latex file maintained by Steve Tayon.  afaik it does not live in a public repo anywhere.  Would be good to get the Latex and generated derivatives (like the PDF attachment on this page) into a repo that can be pointed at directly. - now maintained by Andy Fingerhut on github
    • The actual html content here was last translated manually by Alex Miller and is actually out of date wrt the latest PDF attached.  Need to create an automated process for taking the input, generating the HTML output, and linking the function calls in the page to API docs.  Andy Fingerhut wrote a script for this - yay!  
  • Namespaces and Libs- this is something you're confronted with immediately in writing Clojure but there are not many (any?) good examples on Big improvements needed here, mostly with examples.  Maybe it makes sense to merge these two pages?
  • Agents page  
    • Should mention *agent* ?
  • Java interop page
  • Vars page 
    • Add defrecord, defprotocol
    • Anything else?
  • Lazy page 
    • Currently not on left nav and is out of date
    • BUT it's a source of some useful info that's not well-documented anywhere else - rest vs next and lazy seqs info
    • Please clean and promote to left nav!
  • Libraries page
    • This is probably woefully out of date and will always be so.  It is useful to have a list like this but maybe it would live better in a more open wiki location where many hands could help tend it.  Perhaps is a better home for this kind of info and it should merely be referenced from an appropriate "community" page on - moved to wiki
  • Community page
    • Needs an organizational overhaul so people can scan this to find something near them.  I assume that the ideal organization of this page should thus be geographical, broken down by continent / country / region / city / etc.   - added to wiki by Christopher Redinger and redirected by Rich Hickey on 2/23/11
    • Include Clojure Meetup code discount information or means to get it.- added to new wiki page by Alex Miller on 2/23/11
    • Include a process tip on how to get a new organization listed on this page (email, jira, etc). - added to new wiki page by Alex Miller on 2/23/11
  • Jobs page 
    • Should go away?  - removed by Rich Hickey on 4/11/12
  1. Nov 24, 2011

    Many examples of ns-declerations on use the old deprecated contrib.

  2. Nov 24, 2011

    Jonas Enlund - thanks, added to main page.