Repository navigation
Lay out the documentation like kotlinlang.org/docs - #41
Merged
Merged
Conversation
The three documentation pages each drew their own sidebar. The two hand-built pages listed different topics: Getting started had no link to Syntax. Each page also opened with a capitalized section kicker. DocShell now frames every documentation page: - On the left, the topics of the site, with the current one marked. On a narrow screen they fold into a Contents button above the page. - Above the page, a breadcrumb: site / Documentation / topic. - The page in a column of at most 720 px. - On the right, "On this page". It is read from the h2 headings of the rendered page, and each heading gets an id from its words in any script. It is hidden below 1100 px. - Under the page, previous and next topic cards and an "Edit this page" link to the file the page is written in. DocPage, OverviewPage and GettingStartedPage use it and drop their own sidebars and kickers. The styles of the old layout are removed. The labels are in all four languages.
Contributor
Author
|
Self-review: read the diff. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
One
DocShellnow frames every documentation page on the three sites, in place of three copied sidebars. Getting started had no Syntax link, and each page opened with a capitalized kicker.Labels are in all four languages. The old layout styles are removed.
Testing:
npm run check,format:check,test(44),build. Checked in the browser pane at 1280×800 (Overview, Talac Outputs: sticky TOC, pager, edit link) and 375×812 (Tazel Commands: Contents folded, no overflow), with no console errors. Not merged until the layout is approved.