Fix links in and display of documentation


  • Type: Task Task
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: None
  • Labels:


There is a number of problems with the way the documentation is made available and interlinked:

  • Currently most people likely arrive to and read the README - but it does not point to the docs in ./docs/ => add link to it there
  • It is not clear how the docs are expected to be browsed; I suppose that the .org
    files should be exported to ./docs/wiki/*.markdown yet not all of them are. I also
    suppose that the exported markdown files should be available under, i.e. pushed to
  • Some of the problems:
  • the link "return to documentation" on e.g. "with-constraints" should point to /clojure/core.contracts/wiki, not /clojure/core.contracts/docs.html
  • if wiki is really exported, the main page should mention it is immutable
  • links on the home page had one more 'wiki' in them (fixed manually in the wiki - will be overriden by the next export)
  • some links are broken, f.ex. [defconstrainedfn](/clojure/core.contracts/wiki/defconstrainedfn) on f.ex. contract; [with-constraints](/clojure/core.contracts/with-constraints/) (missing /wiki/), [defcontract](/clojure/core.contracts/wiki/defcontract/)

It would certainly help the project if the documentation was easier to access and browse

Thank you


There are no comments yet on this issue.


Vote (0)
Watch (0)


  • Created: