Skip to content
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

Fix documentation regressions #15170

Merged

Conversation

pikinier20
Copy link
Contributor

@pikinier20 pikinier20 commented May 12, 2022

This pull request addresses change requests mentioned in: #15099

List of changes:

  • Restored documents that were present in docs directory but weren't rendered in documentation
  • Reverted semicolons at the end of lines in syntax-3.1.md
  • Fixed broken links
  • Hide "More details" pages from sidebar

The best option to review this PR is to go commit-by-commit since one commit addresses one issue from the list above.

I'm going to paste there a link to documentation as soon as the CI uploads it.

EDIT: I'll change the target branch to stable docs - it will be then backported to main after merge

@pikinier20 pikinier20 requested a review from odersky May 12, 2022 10:13
@pikinier20 pikinier20 changed the base branch from main to language-reference-stable May 12, 2022 10:16
@pikinier20 pikinier20 changed the base branch from language-reference-stable to main May 12, 2022 10:16
@pikinier20 pikinier20 changed the base branch from main to language-reference-stable May 12, 2022 10:19
@pikinier20 pikinier20 requested a review from julienrf May 12, 2022 10:22
@pikinier20
Copy link
Contributor Author

@pikinier20
Copy link
Contributor Author

I see that syntax.md and syntax-3.1.md have very similar titles. It probably needs renaming:
image

docs/_docs/release-notes-0.1.2.md Show resolved Hide resolved
docs/sidebar.yml Outdated Show resolved Hide resolved
docs/sidebar.yml Outdated Show resolved Hide resolved
@odersky
Copy link
Contributor

odersky commented May 12, 2022 via email

@julienrf julienrf assigned pikinier20 and unassigned odersky May 16, 2022
@pikinier20
Copy link
Contributor Author

Syntax 3.1 got removed from the sidebar.
Indentation-experimental has been renamed to fewer-braces and will be accessible from: experimental/fewer-braces.md
The changes to reference section in sidebar has been ported to stable docs sidebar

Copy link
Collaborator

@julienrf julienrf 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 Filip!

@pikinier20 pikinier20 merged commit d7c3fa4 into scala:language-reference-stable May 17, 2022
@pikinier20 pikinier20 deleted the scaladoc/hide-pages branch May 17, 2022 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants