So many updates #270

its-miroma · 2025-01-22T21:17:48Z

Tip

This diff page may have better performance than the review: main...its-miroma:fmc:framework

Update .github/CODEOWNERS
Update .github/workflows:
- build.yml:
  - run on main only, otherwise pull requests from l10n/main run build twice
  - add conditions to avoid "Run failed" mails
- markdownlint.yml:
  - remove branches, as paths already excludes pull requests from l10n/main
  - remove workflow_dispatch
- publish.yml:
  - run on ubuntu-24.04
  - add conditions to avoid "Run failed" mails
settings.gradle: build latest only
- update.ts: don't add new versions to settings.gradle
Add an h1 heading from $frontmatter.title automatically
- ~~remove all # headings~~
- .markdownlint-cli2.yaml: enable MD025
add new markdownlint rules:
- max-one-sentence-per-line (not in here)
- incorrect-mod-id
- no-horizontal-rules
- no-html-line-breaks
- `no-trailing-punctuation-in-lists
enable lazy image loading
add a footer
format ~~many~~ few files with prettier
add more vscode extension recommendations
hide files that shouldn't be edited in vscode
fix missing codeblock in Block States #272
~~fix formatting mistakes in translated~~
~~lint all markdown files~~
~~delete contributing.md under versions~~

netlify · 2025-01-22T21:18:03Z

✅ Deploy Preview for nimble-elf-d9d491 ready!

Name	Link
🔨 Latest commit	`3c404a5`
🔍 Latest deploy log	https://app.netlify.com/sites/nimble-elf-d9d491/deploys/67adc74713d328000851f2c3
😎 Deploy Preview	https://deploy-preview-270--nimble-elf-d9d491.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

.github/workflows/build.yml

.github/workflows/publish.yml

- Update `.github/CODEOWNERS` - `build.yml`: run on `main` only - otherwise pull requests from `l10n/main` run build twice - `markdownlint.yml`: remove `branches` - `paths` already excludes pull requests from `l10n/main` - `settings.gradle`: build `latest` only - `update.ts`: don't add new versions to `settings.gradle`

its-miroma

~~this PR may be unreviewable~~

its-miroma · 2025-02-03T01:47:04Z

.markdownlint-cli2.yaml

      - name: no-trailing-whitespace
        message: "Don't use trailing whitespace"
        searchPattern: "/ +$/gm"
        replace: ""
        searchScope: code
 customRules:
+  # TODO: add      markdownlint-rule-max-one-sentence-per-line/rule.js


this would be helpful for a few reasons:

no longer worrying about line wraps

longer/complicated sentences stick out

crowdin doesn't show a confusing new line in the middle of source strings

it would however lead to a monstrous diff, so i avoided doing it here.

if i ever wanted to add it, the best way would be to render the markdown files after the sentences split and run a diff on the built files to check for broken/changed formatting

its-miroma · 2025-02-03T01:47:33Z

.vitepress/config.mts

+      image: {
+        lazyLoading: true,
+      },


would appreciate feedback/testing on this

Id argue we dont need this? By the time you scroll down the image it will have already been loaded.

Lazy loading of images allows faster loading of a page because images get loaded when needed.

Check out https://developer.mozilla.org/en-US/docs/Web/Performance/Lazy_loading

its-miroma · 2025-02-03T01:48:27Z

.vitepress/i18n.ts

+    footer: {
+      copyright: websiteResolver("footer.copyright").replace(
+        "%s",
+        `<a href=\"https://github.com/FabricMC/fabric-docs/blob/main/LICENSE\" target=\"_blank\" rel=\"noreferrer\">${websiteResolver("footer.license")}</a>`


unsure what the best way to sanitize footer.license is

a malicious translation could close the </a>...

Maybe use document.createElement("a") with ``.textContent and then get the outerHTML Im not sure if this works in this context though?

its-miroma · 2025-02-03T01:50:42Z

.vitepress/theme/index.ts

+        frontmatter.value.title
+          ? h("h1", { class: "vp-doc" }, frontmatter.value.title)
+          : null,


is there ever a need for two different titles in <head> and <body>?

Yes, the homepage

doc-before (line 35) only includes doc pages, not the homepage nor the 404 page

its-miroma · 2025-02-03T01:51:25Z

.vitepress/theme/style.css

@@ -8,7 +8,7 @@
  font-family: "Flag Emoji Polyfill";
  unicode-range: U+1F1E6-1F1FF, U+1F3F4, U+E0062-E0063, U+E0065, U+E0067,
    U+E006C, U+E006E, U+E0073-E0074, U+E0077, U+E007F;
-  src: url("./CountryFlagsPolyfill.woff2") format('woff2');
+  src: url("./CountryFlagsPolyfill.woff2") format("woff2");


if we used Noto Color Emoji we could embed it without shipping the binary file in the repo

We dont need to include all emojis though, we only need the flags.

contributing.md

.github/workflows/build.yml

.github/CODEOWNERS

.github/workflows/build.yml

.github/workflows/publish.yml

.markdownlint-cli2.yaml

modmuss50 · 2025-02-11T11:53:06Z

.vitepress/config.mts

+      image: {
+        lazyLoading: true,
+      },


Id argue we dont need this? By the time you scroll down the image it will have already been loaded.

modmuss50 · 2025-02-11T11:55:51Z

.vitepress/i18n.ts

+    footer: {
+      copyright: websiteResolver("footer.copyright").replace(
+        "%s",
+        `<a href=\"https://github.com/FabricMC/fabric-docs/blob/main/LICENSE\" target=\"_blank\" rel=\"noreferrer\">${websiteResolver("footer.license")}</a>`


Maybe use document.createElement("a") with ``.textContent and then get the outerHTML Im not sure if this works in this context though?

see FabricMC#270

its-miroma added needs-discussion Further discussion is needed framework Related to the website's framework (Vitepress) stage:verification This should be verified labels Jan 22, 2025

its-miroma requested review from a team as code owners January 22, 2025 21:17

its-miroma requested a review from modmuss50 January 22, 2025 21:19

modmuss50 previously approved these changes Jan 22, 2025

View reviewed changes

its-miroma dismissed modmuss50’s stale review via 4effe9c January 22, 2025 21:36

its-miroma requested a review from modmuss50 January 22, 2025 21:39

its-miroma added stage:ready This is ready to be merged and removed stage:verification This should be verified labels Jan 22, 2025

its-miroma commented Jan 24, 2025

View reviewed changes

.github/workflows/build.yml Outdated Show resolved Hide resolved

.github/workflows/publish.yml Show resolved Hide resolved

its-miroma force-pushed the framework branch 8 times, most recently from 72c82cf to 0bb0c0d Compare January 26, 2025 20:23

its-miroma commented Jan 26, 2025

View reviewed changes

.github/workflows/publish.yml Outdated Show resolved Hide resolved

IMB11 previously approved these changes Jan 31, 2025

View reviewed changes

its-miroma marked this pull request as draft February 1, 2025 00:06

its-miroma added 6 commits February 2, 2025 20:43

Update .github/CODEOWNERS

f2ceb80

Add conditions to avoid "Run failed" mails

ddf3027

Add "Cleanup" job

409ff33

Fix if condition

437034f

Upgrade runs-on to ubuntu-24.04

00ef747

enable lazy loading of images

19902d3

its-miroma dismissed IMB11’s stale review via 7677aa4 February 2, 2025 21:56

its-miroma marked this pull request as ready for review February 3, 2025 01:23

its-miroma changed the title ~~Framework updates~~ Too many updates Feb 3, 2025

its-miroma commented Feb 3, 2025

View reviewed changes

its-miroma added stage:verification This should be verified and removed stage:ready This is ready to be merged labels Feb 3, 2025

its-miroma linked an issue Feb 3, 2025 that may be closed by this pull request

missing codeblock in Block States #272

Open

its-miroma requested review from a team and removed request for modmuss50 February 3, 2025 08:36

its-miroma mentioned this pull request Feb 10, 2025

Migrate loom docs from wiki #278

Open

modmuss50 reviewed Feb 11, 2025

View reviewed changes

its-miroma added 6 commits February 11, 2025 17:48

add more recommended extensions

701d2f0

add h1 heading automatically from frontmatter

c945292

prepare for localization in update

5d467d0

fix FabricMC#272

4153293

override default margin of VPHome

10ad2a6

npm audit fix

24e9df3

its-miroma force-pushed the framework branch 2 times, most recently from d1efd14 to 285d507 Compare February 11, 2025 17:01

its-miroma added 2 commits February 11, 2025 18:39

Update .github/CODEOWNERS

a4850e1

some formatting

c3f0df3

its-miroma force-pushed the framework branch from 285d507 to c3f0df3 Compare February 11, 2025 17:43

its-miroma changed the title ~~Too many updates~~ So many updates Feb 11, 2025

its-miroma mentioned this pull request Feb 12, 2025

Credits Page #280

Open

2 tasks

revert changes to workflows

215d216

its-miroma requested a review from modmuss50 February 12, 2025 20:01

configure allowed_elements

3c404a5

its-miroma added a commit to its-miroma/fmc that referenced this pull request Feb 13, 2025

disable MD033 in credits.md

76f6a6a

see FabricMC#270

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

So many updates #270

So many updates #270

its-miroma commented Jan 22, 2025 •

edited

Loading

netlify bot commented Jan 22, 2025 •

edited

Loading

its-miroma left a comment •

edited

Loading

its-miroma Feb 3, 2025 •

edited

Loading

its-miroma Feb 3, 2025 •

edited

Loading

modmuss50 Feb 11, 2025

its-miroma Feb 12, 2025

its-miroma Feb 3, 2025 •

edited

Loading

modmuss50 Feb 11, 2025

its-miroma Feb 3, 2025

IMB11 Feb 7, 2025

its-miroma Feb 7, 2025

its-miroma Feb 3, 2025

IMB11 Feb 3, 2025

modmuss50 Feb 11, 2025

modmuss50 Feb 11, 2025

So many updates #270

Are you sure you want to change the base?

So many updates #270

Conversation

its-miroma commented Jan 22, 2025 • edited Loading

netlify bot commented Jan 22, 2025 • edited Loading

✅ Deploy Preview for nimble-elf-d9d491 ready!

its-miroma left a comment • edited Loading

Choose a reason for hiding this comment

its-miroma Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

its-miroma Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

its-miroma Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

its-miroma commented Jan 22, 2025 •

edited

Loading

netlify bot commented Jan 22, 2025 •

edited

Loading

its-miroma left a comment •

edited

Loading

its-miroma Feb 3, 2025 •

edited

Loading

its-miroma Feb 3, 2025 •

edited

Loading

its-miroma Feb 3, 2025 •

edited

Loading