Skip to content

Conversation

@BarkingBad
Copy link
Contributor

No description provided.

Copy link
Contributor

@julienrfjulienrf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to link its previous/next page

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you elaborate what headers should I use? I was basing on this page while choosing header settings

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jonathan already told me how to fix this, will push new version soon

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Page shoud be visible now from both root page in Scala 3 section or from /scala3 suburi
obraz

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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...

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sound great, will change :D

@BarkingBadBarkingBadforce-pushed the scaladoc-docs branch 3 times, most recently from 4e754c7 to 1d53e4dCompareMay 11, 2021 14:59
@BarkingBad
Copy link
ContributorAuthor

@julienrf I think the PR should be ready for review, however it should not be merged before update docs PR

@b-studios
Copy link
Contributor

Thanks @BarkingBad! I just made a quick pass over the document and added some suggestions.

@BarkingBad
Copy link
ContributorAuthor

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
obraz

Doesn't exist
obraz

Exists
obraz

Doesn't exist
obraz

I guess I didn't updated some kind of index, could you point me out what should I fix?

@b-studios
Copy link
Contributor

This is really strange. Did you check that it is not a caching problem?

Copy link
Contributor

@julienrfjulienrf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found a few issues. Also, in the matrix comparison I think we should not mark Scala 2 settings that have no equivalent in Scala 3 as “implemented” in the last column.

Comment on lines 47 to 48
|_| -siteroot || We don't migrate it | <iclass="fa fa-check fa-lg"></i> |
|_| -project-logo || Should we migrate it? | <iclass="fa fa-check fa-lg"></i> |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by “We don’t migrate it”? Did it exist in Scala 2?

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah OK, what do you think of using the word “backporting” instead of “migrating”, when it’s about the Scala 3 -> Scala 2 direction?

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, will change

@BarkingBadBarkingBadforce-pushed the scaladoc-docs branch 2 times, most recently from c1baa60 to 8d3e821CompareMay 26, 2021 13:39
@BarkingBadBarkingBad marked this pull request as ready for review May 26, 2021 13:39
@BarkingBad
Copy link
ContributorAuthor

I have applied all the requested changes @julienrf, hope the docs are now understandable.
There will be some dead links at CI pointing to dotty.epfl.ch, however I hope they will be fixed as soon as new nightly will be published

@b-studios I tried pruning docker container, browser caches etc, but with no avail. Do you mind trying to reproduce it locally?

@b-studios
Copy link
Contributor

Hey @BarkingBad, I tried to reproduce your problem, but it looks good on my end. I just noticed an overflow here:

image

@b-studios
Copy link
Contributor

And the CI still fails because some links are broken.

@BarkingBad
Copy link
ContributorAuthor

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.

@BarkingBad
Copy link
ContributorAuthor

@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.

@b-studios
Copy link
Contributor

Looks good now. If @julienrf is happy with the changes I can go ahead and merge.

Copy link
Contributor

@julienrfjulienrf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@julienrfjulienrf merged commit 721dfbd into scala:mainMay 28, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@BarkingBad@b-studios@julienrf@KacperFKorban