-
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
New scaladoc version #16310
New scaladoc version #16310
Conversation
This pull request is created automatically after push to stable documentation branch and backports the changes
- Increase all header levels in files without h2 headers - Fix docs starting with h3 headers - Few other minor header fixes
Remove div from search results
Fix nested html tags
Iteration fixes
Member headers
1dd7097
to
27fe46f
Compare
@julienrf Please take a look at the current version when you have some time, I believe we addressed all the issues aside from the contributors one. The "nightly" banner is now visible. (Deployed to https://szymon-rd.github.io/dotty/scala3/index.html) Rationale for leaving contributors out for now:I played a bit with the contributors and the logic was always to use GH API with /commits endpoint. The rate limiting made it throw errors after about 5-6 requests, so after that, the contributors would not render, and there would be an error. Aside from that, it would be harder to filter out the commits using this endpoint, as you suggested. So the solution seems to be a bigger rework of the contributors' element, including pre-fetching the data during documentation generation and storing this data on the page beforehand. What I’m asking is to maybe put in the next task, as this would take some considerable time to implement. I can revert to the previous version, but the problem with it is that it:
So I think it may be a good idea to go ahead without this element for the current version, as it does not work right now even on the older docs. Given granularity of the contributor's element rework, and the massive size of this PR, I think it would be a good idea to fix in the next task, opening a new PR for it. Additional changes, aside from addressing comments
|
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.
Thank you!
Could you please create an issue (or feature request?) on bringing back the documentation contributors? I think that’s an important feature to have. It would be good to explain the solutions you tried and why they didn’t work. |
Here is the new issue: #16472 |
Congrats for the new Scaladoc! 🎉 I've noticed one last little bug: the message "No results match your filter criteria" does not disappear if you edit your filter (it only disappears when you click on "clear all filters").
|
@TheElectronWill Thank you! I just fixed it :) (It won't deploy, I did it on branch here only) |
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):
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)Next
instead)Fixed bugs with:
clear
icon now appears where it should and with fixed styling. Dropdown fixed as well.In this article
)Additional fixes TODO (from @julienrf )