Skip to content

Conversation

@estelle
Copy link
Member

@estelle estelle commented Feb 19, 2025

updated a bit with some relevant links and headers

related to openwebdocs/project#147

@estelle estelle requested a review from a team as a code owner February 19, 2025 20:35
@estelle estelle requested review from chrisdavidmills and removed request for a team February 19, 2025 20:35
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs size/s [PR only] 6-50 LoC changed labels Feb 19, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Feb 19, 2025

Preview URLs

Flaws (4)

URL: /en-US/docs/Web/CSS/CSS_ruby_layout
Title: CSS ruby layout
Flaw count: 4

  • broken_links:
    • /en-US/docs/Glossary/ruby is ill cased
    • /en-US/docs/Web/CSS/CSS_Display is ill cased
    • /en-US/docs/Web/CSS/CSS_Text_Decoration is ill cased
  • macros:
    • Macro produces link /en-US/docs/Glossary/ruby which is a redirect

(comment last updated: 2025-02-20 18:57:51)

estelle and others added 3 commits February 19, 2025 12:38
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@chrisdavidmills chrisdavidmills left a 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
Copy link
Contributor

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")}}
Copy link
Contributor

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.

Copy link
Member Author

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

Choose a reason for hiding this comment

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

Suggested change
> 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`.

Copy link
Contributor

@chrisdavidmills chrisdavidmills left a 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.

@chrisdavidmills chrisdavidmills merged commit fd52806 into main Feb 21, 2025
12 checks passed
@chrisdavidmills chrisdavidmills deleted the estelle-patch-2 branch February 21, 2025 07:29
cssinate pushed a commit to cssinate/content that referenced this pull request Apr 11, 2025
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:CSS Cascading Style Sheets docs size/s [PR only] 6-50 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants