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

Too many updates #270

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Too many updates #270

wants to merge 19 commits into from

Conversation

its-miroma
Copy link
Member

@its-miroma its-miroma commented Jan 22, 2025

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 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

@its-miroma 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 its-miroma requested review from a team as code owners January 22, 2025 21:17
Copy link

netlify bot commented Jan 22, 2025

Deploy Preview for nimble-elf-d9d491 ready!

Name Link
🔨 Latest commit 4fc916d
🔍 Latest deploy log https://app.netlify.com/sites/nimble-elf-d9d491/deploys/67a3131fb45dcf000892b0e8
😎 Deploy Preview https://deploy-preview-270--nimble-elf-d9d491.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@its-miroma its-miroma requested a review from modmuss50 January 22, 2025 21:19
modmuss50
modmuss50 previously approved these changes Jan 22, 2025
@its-miroma its-miroma requested a review from modmuss50 January 22, 2025 21:39
@its-miroma its-miroma added stage:ready This is ready to be merged and removed stage:verification This should be verified labels Jan 22, 2025
.github/workflows/build.yml Outdated Show resolved Hide resolved
.github/workflows/publish.yml Show resolved Hide resolved
@its-miroma its-miroma force-pushed the framework branch 8 times, most recently from 72c82cf to 0bb0c0d Compare January 26, 2025 20:23
IMB11
IMB11 previously approved these changes Jan 31, 2025
@its-miroma its-miroma marked this pull request as draft February 1, 2025 00:06
- 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`
- `incorrect-mod-id`
- `no-horizontal-rules`
- `no-html-line-breaks`
- `no-trailing-punctuation-in-lists`
- TODO: `max-one-sentence-per-line`

---

- don't lint `versions` at all
@its-miroma its-miroma marked this pull request as ready for review February 3, 2025 01:23
@its-miroma its-miroma changed the title Framework updates Too many updates Feb 3, 2025
Copy link
Member Author

@its-miroma its-miroma left a comment

Choose a reason for hiding this comment

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

this is a contender for the most unreviewable PR in the history of GitHub...

- 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
Copy link
Member Author

@its-miroma its-miroma Feb 3, 2025

Choose a reason for hiding this comment

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

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

Comment on lines +33 to +35
image: {
lazyLoading: true,
},
Copy link
Member Author

@its-miroma its-miroma Feb 3, 2025

Choose a reason for hiding this comment

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

would appreciate feedback/testing on this

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>`
Copy link
Member Author

@its-miroma its-miroma Feb 3, 2025

Choose a reason for hiding this comment

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

unsure what the best way to sanitize footer.license is

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

Comment on lines +36 to +38
frontmatter.value.title
? h("h1", { class: "vp-doc" }, frontmatter.value.title)
: null,
Copy link
Member Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

Yes, the homepage

Copy link
Member Author

Choose a reason for hiding this comment

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

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

@@ -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");
Copy link
Member Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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

Comment on lines -6 to -7
# Contribution Guidelines {#contributing}

Copy link
Member Author

Choose a reason for hiding this comment

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

every single markdown file will have at least a two-line diff.

I've also deleted some contributing files which slipped through in versions

@its-miroma 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 its-miroma linked an issue Feb 3, 2025 that may be closed by this pull request
@its-miroma its-miroma requested review from a team and removed request for modmuss50 February 3, 2025 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework Related to the website's framework (Vitepress) needs-discussion Further discussion is needed stage:verification This should be verified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

missing codeblock in Block States
3 participants