Sync with the stable documentation branch #16483
Merged
Conversation
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Remove div from search results
Fix nested html tags
Fix search results packages
Add second line with description to search result
Iteration fixes
Iteration fixes
Member headers
bishabosha
approved these changes
Dec 9, 2022
PR with new scaladoc version. We want to merge it to language-ref, because there is already a reference version generated with older scaladoc that is bugged in some places. It would be best to replace it fairly quickly. This version deployed: https://szymon-rd.github.io/dotty/scala3/index.html ## Major changes (broadly described): - New search engine and algorithm. It is faster and gives better results. We also fixed its UI and introduced no results page. - Adjustments in articles layout. - Packages now form a tree instead of a linear structure. The `scala` package is first and expanded by default. It also behaves differently now (it doesn't jump in a way that was confusing to the user anymore) - Removed flickering of the page. It now behaves as it was written with some framework with virtual DOMs. We made it by intercepting the event that would make the browser reload the page, and prerendering the page before replacing it. The navigation is also faster because of it. It required us to rework some parts of the website. - New layout of members section and their contents (more concise and with improved readability). - Quick Navigation in API members. ToC are sticky now. - Member section filters are now faster and sticky. Added no results page. - Reworked code snippets style and fonts. - Removed contributors (see comments) - Styled tables in the Docs. - Fixed flow of releasing ScalaDoc by modyfing the tasks. It should be now easier to generate the stable docs, and the versions are fixed in the testcases config. - A lot of minor changes in styling and structure of both docs and API sections. We've redesigned the majority of the page and analyzed the implementation side to side to make it strictly match the designs. - Introduced new icons. - More details pages are now visible (going to change that and make them not appear under `Next` instead) ## Fixed bugs with: - Search overlay not always disappearing when clicked outside. - Bad paths in search results. - Rendering of members filters. The `clear` icon now appears where it should and with fixed styling. Dropdown fixed as well. - Empty pages in docs - Rendering, updating and structure of ToC (`In this article`) - Missing pointer cursor - Article content shifting when no ToC. - Collapsing side nav items. - Page jumping when going directly to members. - Mobile menu not appearing on some resolutions. - Member details hiding on interaction with inheritance graph. - Missing spaces in search results. - Recent searches not working as intended. - Linking to a section that has its name duplicated in one doc. Now they get unique id on duplicates. - More minor ones. ## Additional fixes TODO (from @julienrf ) - [x] Instead of showing in the sidebar the previously hidden pages, hide them also from the “Next” buttons - [x] Don’t show all the super types of classes in the list view - [x] In the detailed view, show the super types of classes, but use a comma instead of with - [x] Bring back the “This is a nightly documentation. …” banner (with proper styling) - [x] Fix the “Uncaught TypeError”s - [x] Make the table of contents (“In this article” box) scrollable - [x] Make header names (long package names) scrollable - [ ] Bring back the list of contributors (use --ignore-revs-file)
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 pull request is syncing the main with changes from language-reference-stable.
It was created automatically after 29639f9 by @WojciechMazur