sproutcore / docs

The documentation source. Build and push to https://github.com/sproutcore-docs/sproutcore-docs.github.com.
http://docs.sproutcore.com
MIT License
14 stars 8 forks source link

Integration of SC docs into Dash #5

Closed mirion closed 11 years ago

mirion commented 11 years ago

Dash is a little nice tool that provides documentation and API browser. More details at: http://kapeli.com/dash

It accepts custom document sets and I think that we should propose to the developer to integrate SC into his standard collection. This is not only for our own use, but also to promote SC.

For the time being I identified only 2 aspects that need some work:

  1. Build the SC docs so all the links, references, etc are using relative paths. For the time being, the standard build is tailored for hosting at the root of docs.sproutcore.com . For this step I modified the doc templates it works quite well, except the links to the inherited methods and fields, due to some url manipulation that is done in JS. If somebody knows how this works, it would be very helpful to make the changes or give me some hints so we can advance fast.
  2. Build an SQlite index database, so Dash can quickly search the docs. When creating the docs, and generating the symbols, each of them has to produce a line into an SQL script that is later used to create the SQLite database. For this step I didn't make any progress so as above any help is welcome. Thanks

More documentation at: http://kapeli.com/docsets