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

Minor documentation fixes #6

Merged
merged 2 commits into from
Jul 11, 2024
Merged

Conversation

jschwe
Copy link
Member

@jschwe jschwe commented Jul 9, 2024

Comment on lines -49 to +55
| Label | Runs unit tests on | Runs web tests on |
|---|---|---|
| `T-full` | All platforms | Linux |
| `T-linux-wpt-2013` | Linux | Linux (only legacy layout) |
| `T-linux-wpt-2020` | Linux | Linux (skip legacy layout) |
| `T-macos` | macOS | (none) |
| `T-windows` | Windows | (none) |
| Label | Runs unit tests on | Runs web tests on |
|--------------------|--------------------|----------------------------|
| `T-full` | All platforms | Linux |
| `T-linux-wpt-2013` | Linux | Linux (only legacy layout) |
| `T-linux-wpt-2020` | Linux | Linux (skip legacy layout) |
| `T-macos` | macOS | (none) |
| `T-windows` | Windows | (none) |
Copy link
Member

Choose a reason for hiding this comment

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

hmm, generally i think we’ll want to prioritise diff and history readability over the readability that comes with aligning things, but let’s go ahead with the change and see how it goes :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Would adding a markdown linter CI workflow be an option, to enforce some style consistency (e.g. denying too long lines, or reminding people to add alt-text for embedded pictures)?

Copy link
Member

@delan delan Jul 10, 2024

Choose a reason for hiding this comment

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

maybe! the long lines are intentional, but i would imagine we could configure that kind of thing. i’m not familiar with tooling for markdown, do you have a preferred linter?

Copy link
Member Author

Choose a reason for hiding this comment

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

the long lines are intentional

I see

i’m not familiar with tooling for markdown, do you have a preferred linter?

Well, I'm not too familiar either honestly. I mostly use IntelliJ IDEs (RustRover / CLion) when developing, and I couldn't find any detail on if they are using an existing opensource linter, or have a custom linter.
Some quick googling found markdownlint, which seems to be quite configurable and also has an associated github action.

Perhaps we should move further discussion into an issue though, since adding a markdown linter should probably be done in a separate PR and would require further discussion.

@jschwe jschwe force-pushed the jschwender/minor_doc_fixes branch from bf09021 to a12110d Compare July 10, 2024 07:35
jschwe added 2 commits July 11, 2024 20:38
The android package was renamed in
servo/servo#32554

Signed-off-by: Jonathan Schwender <jonathan.schwender@huawei.com>
Signed-off-by: Jonathan Schwender <jonathan.schwender@huawei.com>
@delan delan force-pushed the jschwender/minor_doc_fixes branch from a12110d to fafde7e Compare July 11, 2024 12:38
Copy link
Member

@delan delan left a comment

Choose a reason for hiding this comment

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

Thanks!

@delan delan merged commit f1e4138 into servo:main Jul 11, 2024
delan pushed a commit that referenced this pull request Jul 11, 2024
The android package was renamed in
servo/servo#32554

Signed-off-by: Jonathan Schwender <jonathan.schwender@huawei.com>
@jschwe jschwe deleted the jschwender/minor_doc_fixes branch July 11, 2024 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants