-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tweak Language Reference documentation #14669
Tweak Language Reference documentation #14669
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The diff looks good to me, but please share the PR online URL when it is ready so that we can do more checks.
<a href="{{ child.url }}">{{ child.title }}</a> | ||
</li> | ||
{% endfor %} | ||
</ul> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great idea!
2e91778
to
06d6152
Compare
06d6152
to
4b3e218
Compare
07d2574
to
4fc4951
Compare
I looked at this, shouldn't the more-details pages be hidden from contents/index? - if not I guess in the future we can do more to maybe inline the content of those pages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apart from the point raised by Jamie, this looks great!
The |
I considered that the reason they did not appear in the nav-bar was because those pages are meant to be "private to" the page they are linked from, and its just incidental that they had a different url. So I advocate in this case for modal content, or "reveal" boxes or whatever - or if none of that then we should retitle the pages or inline their content |
We can make another section on these pages called: More details and then put there the "more advanced" stuff. It will work great with Table of Contents |
@julienrf @bishabosha If the "More details" pages are the only concern, could we merge this PR and make another PR with the documentation changes? Perhaps you wanna take it over? |
overview
page, changed the index of section tooverview
and created redirects so that link to oldoverview.html
leads toindex.html