Doc page improvements #35
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Put API docs above relish docs to emphasize them more. - Expand description of API docs and relish docs - List each library with a description
| article.rdoc | ||
| h2 API Documentation | ||
| article.relish | ||
| h2 Relish |
There was a problem hiding this comment.
I think Relish is a better starting point than the API documentation and thus should be at the top...
There was a problem hiding this comment.
I specifically put the API docs on top because I feel we should advertise them as the more primary/main docs. We've gotten a lot of complaints about the relish docs and I think it's time to de-emphasize them.
|
@JonRowe, is this good to merge? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm not really happy with the formatting on this page, particularly the version listing. Ideally, we'd have a drop-down similar to what's on relish for the versions but I'm not sure how to do that.