Skip to content

Comments

Check max line width to 120 chars in prettier#381

Closed
AlexAndBear wants to merge 3 commits intomainfrom
prettier-set-max-line-chars
Closed

Check max line width to 120 chars in prettier#381
AlexAndBear wants to merge 3 commits intomainfrom
prettier-set-max-line-chars

Conversation

@AlexAndBear
Copy link
Member

No description provided.

Copilot AI review requested due to automatic review settings July 14, 2025 23:07
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the Prettier configuration to allow longer lines and forces prose wrapping, and standardizes image inlining across the German documentation.

  • Added printWidth: 120 and proseWrap: "always" to prettier.config.js
  • Inlined image tags and consolidated broken lines in the German markdown docs
  • Updated formatting and fixed a few typos in key German docs

Reviewed Changes

Copilot reviewed 150 out of 150 changed files in this pull request and generated no comments.

Show a summary per file
File Description
prettier.config.js Increased max line width to 120 and enabled prose wrapping
i18n/de/docusaurus-plugin-content-docs/current/user/spaces/rename.md Inlined rename button image and adjusted line breaks
i18n/de/docusaurus-plugin-content-docs/current/user/spaces/delete.md Inlined delete button image and adjusted line breaks
i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/general/settings.md Fixed image inlining and updated line breaks
i18n/de/docusaurus-plugin-content-docs/current/user/sharing/external.md Inlined image and cleaned up German spelling/formatting
Comments suppressed due to low confidence (4)

i18n/de/docusaurus-plugin-content-docs/current/user/spaces/rename.md:20

  • The image width is set to "19200" which seems unintended. It should likely be "1920" to match other images.
  wählen Sie **Umbenennen**. <img src={require("./img/rename/umbenennen-button.png").default} alt="Rename"

i18n/de/docusaurus-plugin-content-docs/current/user/spaces/delete.md:21

  • Typo: "aud" should be "auf" in "im Kontext-Menü auf Deaktivieren".
- Klicken Sie in der **Top-Bar** oder im **Kontext-Menü** aud **Deaktivieren**, um den Space in einen deaktivierten

i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/general/settings.md:66

  • Typo: "Mehfachauswahl" should be "Mehrfachauswahl".
verhindern.

i18n/de/docusaurus-plugin-content-docs/current/user/sharing/external.md:13

  • Typo: "Öffenlichen" should be "Öffentlichen".
Mit **Öffenlichen Links** können Dateien und Ordner **organisationsübergreifend** geteilt werden. <br/><br/>

@AlexAndBear
Copy link
Member Author

AlexAndBear commented Jul 14, 2025

@JammingBen @Svanvith what y'all think? Not everything is perfect but it makes it more readable and uniform in the editor

@Svanvith also changed back from bash to shell as this is more correct, since we use commands and not so much bash scripts

Copy link
Member

@JammingBen JammingBen left a comment

Choose a reason for hiding this comment

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

Didn't go through all files yet, but a few things seem to break this way.

Also, it throws me off quite a bit when there are line breaks in the middle of sentences (here in GitHub I mean). Should we really have this for markdown files? Any IDE should support automatic line breaks so users don't have to scroll horizontally.


Follow the steps below to install and configure OpenCloud on your system.<br/>
This example is on Linux Ubuntu 24.04 distribution!
Follow the steps below to install and configure OpenCloud on your system.<br/> This example is on Linux Ubuntu 24.04
Copy link
Member

Choose a reason for hiding this comment

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

On a general note: Do we need to use <br/> in markdown files? Usually an empty lines results in such.

Suggested change
Follow the steps below to install and configure OpenCloud on your system.<br/> This example is on Linux Ubuntu 24.04
Follow the steps below to install and configure OpenCloud on your system.
This example is on Linux Ubuntu 24.04

Comment on lines +13 to +15
:::danger[Disclaimer] Bare-metal deployments are not officially supported by OpenCloud. They are great for quick
evaluation but are undocumented and have a minimalist feature set. If you choose this setup, you are on your own. With
great power comes great responsibility. :::
Copy link
Member

Choose a reason for hiding this comment

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

I guess you need the line breaks after :::danger and before ::: for this to display correctly. This happens in several locations.

```Shell
docker compose stop
```
```shell docker compose stop ```
Copy link
Member

Choose a reason for hiding this comment

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

The line breaks need to stay as they were for this to display. This also happens on multiple locations.

Copy link
Member Author

Choose a reason for hiding this comment

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

Those are bad news mdx seems to be not quite supported

@AlexAndBear
Copy link
Member Author

Closing this as the formatter breaks too many LOC. seems not be optimized for mdx either

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.

2 participants