-
Notifications
You must be signed in to change notification settings - Fork 23k
Ruby module landing page #38239
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
Ruby module landing page #38239
Conversation
|
Preview URLs Flaws (4)URL:
(comment last updated: 2025-02-20 18:57:51) |
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
chrisdavidmills
left a comment
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.
@estelle looking generally OK, but I've got a few comments for you to consider.
One additional comment — I'm not allowed to make a change suggestion on the article intro paragraph because you've not touched it in this PR, but it reads weird to me. First of all, other online texts talk about ruby annotations rather than ruby annotation, and there is a plurality mismatch between different parts of the paragraph. Also, the usage definition of ruby annotations includes "annotations" — it is never good to provide a definition that uses the same word you are trying to define.
To fix these issues, I wonder if you'd consider the following update to the intro paragraph:
The CSS ruby layout module provides the rendering model and formatting controls related to the display of ruby annotations. Ruby annotations are a form of interlinear annotation, consisting of short runs of text alongside the base text. They are typically used in East Asian documents to indicate pronunciation or define meaning.
|
|
||
| ## Related concepts | ||
|
|
||
| [CSS display](/en-US/docs/Web/CSS/CSS_Display) module |
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.
The spacing looks a bit weird in these lists. In other module landing pages, the related concepts lists are done as a single list with sub-bullets, rather than paragraphs and separate lists. Maybe update this to the same style?
|
|
||
| ### Glossary and keywords | ||
|
|
||
| - {{Glossary("ruby")}} |
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.
Hrm, this Ruby page defines both Ruby/ROR and Ruby annotations; it could really do with splitting up into disambiguation pages. But I'm not sure if you want to do that here, or in a different PR. I won't block this PR on it.
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.
different PR
| - {{cssxref("ruby-position")}} | ||
|
|
||
| > [!NOTE] | ||
| > CSS ruby layout module introduces two properties that have not been implemented: `ruby-merge`, `ruby-overhang`. |
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.
| > CSS ruby layout module introduces two properties that have not been implemented: `ruby-merge`, `ruby-overhang`. | |
| > The CSS ruby layout module introduces two properties that have not been implemented: `ruby-merge`, `ruby-overhang`. |
chrisdavidmills
left a comment
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.
@estelle awesome; time to get this merged.
* Ruby module landing page * typo * Update files/en-us/web/css/css_ruby_layout/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * see also * Update index.md * layout of related * note --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
updated a bit with some relevant links and headers
related to openwebdocs/project#147