Skip to content


Subversion checkout URL

You can clone with
Download ZIP


YARD server should display README on index route. #385

ghost opened this Issue · 1 comment

1 participant


IMO, yard server should display README.txt(or the file passed to --main) on the index route when using the frameless template.

Related issue:


So right now the "index" action is always pointing to class/file index page, which I think makes for a good "index". We would have to make the class index page move to another route, but I can't think of any proper name besides "index", and that would be confusing, given the meaning of /index.*

I feel like this should probably be moved to target 0.8.0, cause there needs to be some discussion on a better name, and there might be some compat issues in changing the routes on people in a patch release.

@lsegal lsegal closed this issue from a commit
@lsegal Server displays README on index route if available.
Renames the index route to /docs/[library/]index.

Closes #385
@lsegal lsegal closed this in 050518e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.