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

Tweak Language Reference documentation #14669

Merged

Conversation

pikinier20
Copy link
Contributor

  • For sections that had overview page, changed the index of section to overview and created redirects so that link to old overview.html leads to index.html
  • Added dummy index pages to sections that didn't have any index. The default content of index page is a table of child pages.
  • Turned off snippet run feature for snippets that are not checked with snipper compiler or failed.
  • Deleted version picker for reference documentation

Copy link
Contributor

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

The diff looks good to me, but please share the PR online URL when it is ready so that we can do more checks.

<a href="{{ child.url }}">{{ child.title }}</a>
</li>
{% endfor %}
</ul>
Copy link
Contributor

Choose a reason for hiding this comment

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

Great idea!

docs/_layouts/index.html Outdated Show resolved Hide resolved
@pikinier20 pikinier20 force-pushed the scaladoc/tweak-reference-documentation branch from 06d6152 to 4b3e218 Compare March 15, 2022 10:16
@pikinier20 pikinier20 force-pushed the scaladoc/tweak-reference-documentation branch from 07d2574 to 4fc4951 Compare March 15, 2022 10:36
@pikinier20
Copy link
Contributor Author

@bishabosha
Copy link
Member

bishabosha commented Mar 15, 2022

https://scala3doc.virtuslab.com/pr-tweak-reference-documentation/reference/index.html

I looked at this, shouldn't the more-details pages be hidden from contents/index? - if not I guess in the future we can do more to maybe inline the content of those pages

Copy link
Contributor

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

Apart from the point raised by Jamie, this looks great!

@pikinier20
Copy link
Contributor Author

The More details pages were hidden but I revealed them at some point. Isn't it better to let user know that such page exists instead to have only one place on site where he can navigate to it?

@bishabosha
Copy link
Member

bishabosha commented Mar 15, 2022

The More details pages were hidden but I revealed them at some point. Isn't it better to let user know that such page exists instead to have only one place on site where he can navigate to it?

I considered that the reason they did not appear in the nav-bar was because those pages are meant to be "private to" the page they are linked from, and its just incidental that they had a different url. So I advocate in this case for modal content, or "reveal" boxes or whatever - or if none of that then we should retitle the pages or inline their content

@pikinier20
Copy link
Contributor Author

pikinier20 commented Mar 15, 2022

We can make another section on these pages called: More details and then put there the "more advanced" stuff.

It will work great with Table of Contents

@pikinier20
Copy link
Contributor Author

@julienrf @bishabosha If the "More details" pages are the only concern, could we merge this PR and make another PR with the documentation changes? Perhaps you wanna take it over?

@bishabosha bishabosha merged commit 21a5401 into scala:main Mar 17, 2022
@bishabosha bishabosha deleted the scaladoc/tweak-reference-documentation branch March 17, 2022 10:06
@Kordyjan Kordyjan added this to the 3.1.3 milestone Aug 2, 2023
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.

4 participants