Readme sections in sidebar #535
Closed
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
|
Personally, I do not think the redirect is needed. |
|
@Blendify do you think the landing page needs some more content then? Without the redirect, readers will land on a page with only toctree that they need to click through. |
|
We can include the first couple of lines from the readme me? Or just
manually duplicate the content.
…On Jan 10, 2018 4:38 AM, "Jesse Tan" ***@***.***> wrote:
@Blendify <https://github.com/blendify> do you think the landing page
needs some more content then? Without the redirect, readers will land on a
page with only toctree that they need to click through.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#535 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AOeua8ikFSD_3HpGyy0SJI8SVdExrQ-sks5tJIT6gaJpZM4RPFVa>
.
|
|
Poke, I would just include an introductory statement in the index this should be adequate to describe the project. |
|
I'm waiting to see what the outcome of #532 is, since it may affect the way we can get the README to show up in the sidebar. |
|
The is obsolete now with 67bb54d |
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.
This PR makes the README sections appear in the navbar.
It uses an intermediate file to indirectly include the README (
toctreedoes not allow including files that are in a parent directory).The location of the README remains unchanged (so it renders nicely on GitHub).
A JavaScript redirect is used to send viewers directly to the README page, rather than displaying a page containing only the table of contents.
Fixes #523.