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(writing guidelines): Mention recommended sources for lorem ipsum #38677

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

OnkarRuikar
Copy link
Contributor

The CSpell recognizes the standard lorem ipsum text. It reports other versions of lorem ipsum as unknown words. We also need to maintain consistency.

We don't want authors to use other versions of the filler text.

@OnkarRuikar OnkarRuikar requested review from a team as code owners March 17, 2025 03:35
@OnkarRuikar OnkarRuikar requested review from chrisdavidmills and pepelsbey and removed request for a team March 17, 2025 03:35
@github-actions github-actions bot added Content:Meta Content in the meta docs system [PR only] Infrastructure and configuration for the project size/s [PR only] 6-50 LoC changed labels Mar 17, 2025
Copy link
Contributor

Preview URLs

External URLs (2)

URL: /en-US/docs/MDN/Writing_guidelines/Writing_style_guide
Title: Writing style guide

@@ -381,6 +381,8 @@ yarn lint:typos

In the repository, we maintain several word lists, located at [`.vscode/dictionaries`](https://github.com/mdn/content/tree/main/.vscode/dictionaries), that contain sanctioned words not in the default dictionaries. You can add more words to these lists if they are valid but reported by the spell checker. Read [`.vscode/cspell.json`](https://github.com/mdn/content/blob/main/.vscode/cspell.json) to understand what each dictionary contains and the details of our spell-checking configuration.

Use the filler lorem-ipsum text from [`www.lipsum.com`](https://www.lipsum.com) or [`lorem ipsum`](https://marketplace.visualstudio.com/items?itemName=Tyriar.lorem-ipsum) VSCode pluging.
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be put somewhere standalone. It's a editorial standardization, not just a technical change.

@Josh-Cena
Copy link
Member

Copying over #38671 (comment):

regarding the lipsum in the container query page: it appears to me that https://www.lipsum.com/, when requested different number of paragraphs, returns different texts, so it seems we are confined to only 5 paragraphs for the default text that https://www.lipsum.com/feed/html returns, but then we can't really re-implement that example unless we duplicate the text for every fake section—which we can but will look less natural. Should we solidify that in the writing guidelines as well (only use the 5-paragraph version)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Meta Content in the meta docs size/s [PR only] 6-50 LoC changed system [PR only] Infrastructure and configuration for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants