Add scaladoc docs #2012
Add scaladoc docs #2012
Conversation
There was a problem hiding this comment.
Thank you @BarkingBad! I think this would be a useful addition, although I found a few issues.
| @@ -0,0 +1,68 @@ | |||
| --- | |||
| layout: singlepage-overview | |||
| title: New features for Scaladoc | |||
There was a problem hiding this comment.
I think you need to link its previous/next page
There was a problem hiding this comment.
Could you elaborate what headers should I use? I was basing on this page while choosing header settings
There was a problem hiding this comment.
I am not sure, actually. It seems there are no next/previous pages in this layout.
Did you check that the website renders correctly? Is your page reachable from the index page? Maybe you need to add it to the index.md page?
There was a problem hiding this comment.
Jonathan already told me how to fix this, will push new version soon
There was a problem hiding this comment.
Page shoud be visible now from both root page in Scala 3 section or from /scala3 suburi
There was a problem hiding this comment.
@BarkingBad @julienrf What do you think of changing the title of the document to: "All new Scaladoc for Scala 3"? Just to emphasize its relation to Scala 3 again...
There was a problem hiding this comment.
Sound great, will change :D
BarkingBad
force-pushed
the
scaladoc-docs
branch
3 times, most recently
from
4e754c7 to
1d53e4d
Compare
|
Thanks @BarkingBad! I just made a quick pass over the document and added some suggestions. |
|
Hey, I have added migration guide as @julienrf asked me, however I encounter weird behaviour. Sometimes, my article is not visible in the navigation tree Exists Doesn't exist Exists Doesn't exist I guess I didn't updated some kind of index, could you point me out what should I fix? |
|
This is really strange. Did you check that it is not a caching problem? |
| | _ | -siteroot | | We don't migrate it | <i class="fa fa-check fa-lg"></i> | | ||
| | _ | -project-logo | | Should we migrate it? | <i class="fa fa-check fa-lg"></i> | |
There was a problem hiding this comment.
What do you mean by “We don’t migrate it”? Did it exist in Scala 2?
There was a problem hiding this comment.
These are the new features of scaladoc that we were considering whether we should implement them in the old scaladoc, however we know that -siteroot as the static site would be too tiresome to migrate it.
There was a problem hiding this comment.
Ah OK, what do you think of using the word “backporting” instead of “migrating”, when it’s about the Scala 3 -> Scala 2 direction?
There was a problem hiding this comment.
Good idea, will change
BarkingBad
force-pushed
the
scaladoc-docs
branch
2 times, most recently
from
c1baa60 to
8d3e821
Compare
|
I have applied all the requested changes @julienrf, hope the docs are now understandable. @b-studios I tried pruning docker container, browser caches etc, but with no avail. Do you mind trying to reproduce it locally? |
|
Hey @BarkingBad, I tried to reproduce your problem, but it looks good on my end. I just noticed an overflow here:
|
|
And the CI still fails because some links are broken. |
|
Oh, ok, didn't see the overflow, will change to codeblock instead. As it comes to CI, as I said we have to wait till the nightly will be published, unfortunately, the last one failed so links are not updated yet. |
|
@b-studios, hopefully new documentation at dotty.epfl.ch has been published this night, so all links should be good now. Could you rerun CI task since I don't have permission to do so. |
|
Looks good now. If @julienrf is happy with the changes I can go ahead and merge. |
No description provided.