[pull] master from mmistakes:master #1

pull · 2024-05-08T09:41:16Z

See Commits and Changes for more details.

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by CodeRabbit

New Features
- Added localization support for Polish, Finnish, Ukrainian, and Czech languages.
- Introduced support for right-to-left (RTL) languages.
- Added new configuration options for skins, pagination, and copy button on code blocks.
- Implemented auto-scroll for the Table of Contents.
- Updated social sharing links to reflect Twitter rebranding to X with improved accessibility.
- Enhanced UI text translations and added new languages.
Bug Fixes
- Corrected float direction issues and fixed broken links.
- Improved accessibility adjustments and heading levels.
- Ensured proper functionality of Algolia search index and social sharing links.
Documentation
- Expanded and detailed CHANGELOG with comprehensive release notes.
- Revised configuration documentation with new skins and pagination sections.
- Updated README removing sponsorship badges and refreshing localization language list.
- Added developer notes on version updates and credits.
Chores
- Enhanced GitHub Actions workflow with expanded permissions and improved pull request labeling.
- Implemented automatic updates for dependencies and improved build process with GitHub Actions.

Co-authored-by: Marco Omainska <[email protected]>

Co-authored-by: Niklas Engblom <[email protected]>

To avoid getting JS and irrelevant files indexed remove pages where title is null. This gives a much cleaner Lunr store with more relevant content.

* Lazy-load InstantSearch scripts and stylesheets * Replace outdated script parts

Removed url encoding of the article link

* Allow to optionally define website copyright holder name and url using site.copyright and site.copyright_url * Update _config.yml --------- Co-authored-by: iBug <[email protected]>

* Fix non-English characters being url encoded in breadcrumb * Remove `| replace: '%20', ' ‘`

Call it a day for now

Now only 4 files left untouchable. Search README.md for "Dev note" for details.

Co-authored-by: Andrii Burkatskyi <[email protected]>

…override

…4959)

coderabbitai

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (90)

docs/_posts/2009-10-06-edge-case-broken-highlighting.md (1)

26-26: Specify a language for the code block.

Markdownlint suggests specifying a language for the fenced code block to improve syntax highlighting. Consider adding a language identifier.
-```
+```plaintext
Tools

Markdownlint

26-26: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

docs/_docs/22-faq.md (1)

11-18: Informative FAQ entry. Consider expanding.

The FAQ entry provides a clear explanation and solution for a common error. Consider expanding the FAQ section with more entries as the page is under construction.

.github/workflows/build.yml (2)

1-47: Consider specifying required_ruby_version.

It's recommended to specify the required_ruby_version in the gemspec file to ensure compatibility with the Ruby version used in the workflow.
+  spec.required_ruby_version = ">= 2.5"
1-47: Missing Gemfile.lock file in the repository

The docs/Gemfile.lock file is not present in the repository. This may lead to issues with the caching step in the GitHub Actions workflow, as it attempts to cache this file. Ensure that Gemfile.lock is generated and committed to the repository to align with the workflow's setup.

Analysis chain

LGTM! Verify the setup and configuration.

The GitHub Actions workflow is well-structured for building the project. This change is approved.

However, ensure that the setup and configuration align with the project's requirements and environment.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the setup and configuration of the GitHub Actions workflow.

# Test: Check for the presence of necessary files and configurations.
if [ -f "docs/Gemfile" ]; then
  echo "Gemfile found"
else
  echo "Gemfile not found"
fi

if [ -f "docs/Gemfile.lock" ]; then
  echo "Gemfile.lock found"
else
  echo "Gemfile.lock not found"
fi
Length of output: 148

_includes/footer.html (1)

21-21: Ensure Configuration of URL Settings

The copyright_url and url settings in your _config.yml file are currently commented out. To avoid potential broken links in your footer, ensure these are correctly configured and uncommented.

_config.yml: Uncomment and set copyright_url and url to valid URLs.

Analysis chain

Clickable copyright link.

The copyright text is now a clickable link, which improves user navigation. Ensure that site.copyright_url and site.url are correctly configured to avoid broken links.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify if `site.copyright_url` and `site.url` are correctly configured.

# Test: Search for the configuration of `copyright_url` and `url`. Expect: Configuration present in site settings.
rg --type yaml 'copyright_url|url'
Length of output: 14344

docs/_docs/04-upgrading.md (2)

35-35: Clarify the remote theme instructions.

The instructions for setting the remote_theme now include dynamic versioning. Ensure users understand how to adjust this if necessary.

Consider adding a brief explanation or link to further documentation on using dynamic variables in Jekyll.

37-37: Ensure completeness of the rollback example.

The rollback example provides a specific commit reference. Ensure that this example is clear and that users understand how to find commit hashes.

Consider adding a note on where to find commit hashes in the GitHub interface.

CHANGELOG.md (83)

7-9: Ensure consistency in enhancement descriptions.

The descriptions for enhancements should consistently include the context or reason for the change, if applicable. Consider adding more detail to the "Add RTL Support" and "Add missing Polish translation" entries to provide better context.

- Add RTL Support. [#4886](https://github.com/mmistakes/minimal-mistakes/pull/4886)
+ Add support for right-to-left (RTL) languages to improve accessibility for RTL language users. [#4886](https://github.com/mmistakes/minimal-mistakes/pull/4886)

13-14: Clarify bug fix descriptions.

The description for the bug fix "Replace a redirected link to MadeMistakes in footer" could include the reason for the change or the impact of the fix.

- Replace a redirected link to MadeMistakes in footer. [#4882](https://github.com/mmistakes/minimal-mistakes/pull/4882)
+ Replace a redirected link to MadeMistakes in the footer to ensure users are directed to the correct page. [#4882](https://github.com/mmistakes/minimal-mistakes/pull/4882)

24-25: Provide context for enhancements.

The enhancement "Add Czech localization" could benefit from additional context about the impact or reason for the change.

- Add Czech localization. [#4866](https://github.com/mmistakes/minimal-mistakes/pull/4866)
+ Add Czech localization to support users in the Czech language. [#4866](https://github.com/mmistakes/minimal-mistakes/pull/4866)

35-36: Correct minor typographical error.

The word "typo" in "Fix typo for fa-dribbble in _utilities.scss" could be replaced with "error" for consistency with other entries.

- Fix typo for `fa-dribbble` in `_utilities.scss`.
+ Fix error for `fa-dribbble` in `_utilities.scss`.

51-52: Clarify bug fix description.

The description "Fix an unclosed <p> tag in page__hero.html, near page.header.actions" could include the impact of the fix.

- Fix an unclosed `<p>` tag in `page__hero.html`, near `page.header.actions`.
+ Fix an unclosed `<p>` tag in `page__hero.html`, near `page.header.actions`, to prevent rendering issues on the page.

82-83: Clarify bug fix description.

The description "Replaced dead link to 'Viewport and Media Queries' slides" could include the impact or reason for the change.

- Replaced dead link to "Viewport and Media Queries" slides. [#4421](https://github.com/mmistakes/minimal-mistakes/discussions/4421)
+ Replaced dead link to "Viewport and Media Queries" slides to ensure users have access to the correct resources. [#4421](https://github.com/mmistakes/minimal-mistakes/discussions/4421)

105-106: Clarify bug fix description.

The description "Fix Linkedin social share link" could include the impact or reason for the change.

- Fix Linkedin social share link [#4754](https://github.com/mmistakes/minimal-mistakes/issues/4754)
+ Fix Linkedin social share link to ensure proper functionality and user experience. [#4754](https://github.com/mmistakes/minimal-mistakes/issues/4754)

Line range hint 166-167: Clarify enhancement description.

The description "Remove IE9 flexbox fallback" could include the reason or impact of the change.

- Remove IE9 flexbox fallback. [#3042](https://github.com/mmistakes/minimal-mistakes/pull/3042)
+ Remove IE9 flexbox fallback to simplify code and improve maintainability as IE9 usage declines. [#3042](https://github.com/mmistakes/minimal-mistakes/pull/3042)

Line range hint 216-217: Clarify enhancement description.

The description "Add Arabic (عربي) localized UI text strings" could include the impact or reason for the change.

- Add Arabic (عربي) localized UI text strings. [#2936](https://github.com/mmistakes/minimal-mistakes/pull/2936)
+ Add Arabic (عربي) localized UI text strings to support Arabic-speaking users. [#2936](https://github.com/mmistakes/minimal-mistakes/pull/2936)

Line range hint 263-264: Clarify enhancement description.

The description "Allow custom sorting for collections" could include the impact or reason for the change.

- Allow custom sorting for collections. [#2723](https://github.com/mmistakes/minimal-mistakes/pull/2723)
+ Allow custom sorting for collections to give users more control over content organization. [#2723](https://github.com/mmistakes/minimal-mistakes/pull/2723)

Line range hint 307-308: Clarify bug fix description.

The description "Fix greedy navigation by improving reliability of remaining space for visible links" could include the impact or reason for the change.

- Fix greedy navigation by improving reliability of remaining space for visible links. [#2664](https://github.com/mmistakes/minimal-mistakes/issues/2664)
+ Fix greedy navigation by improving reliability of remaining space for visible links to enhance user experience on smaller screens. [#2664](https://github.com/mmistakes/minimal-mistakes/issues/2664)

251-252: Clarify bug fix description.

The description "Fix grid entries_layout in home.html" could include the impact or reason for the change.

- Fix grid `entries_layout` in home.html. [#2616](https://github.com/mmistakes/minimal-mistakes/pull/2616)
+ Fix grid `entries_layout` in home.html to ensure proper layout and display of content. [#2616](https://github.com/mmistakes/minimal-mistakes/pull/2616)

251-252: Clarify bug fix description.

The description "Fix grid entries_layout in home.html" could include the impact or reason for the change.

- Fix grid `entries_layout` in home.html. [#2616](https://github.com/mmistakes/minimal-mistakes/pull/2616)
+ Fix grid `entries_layout` in home.html to ensure proper layout and display of content. [#2616](https://github.com/mmistakes/minimal-mistakes/pull/2616)

251-252: Clarify bug fix description.

The description "Fix grid entries_layout in home.html" could include the impact or reason for the change.

- Fix grid `entries_layout` in home.html. [#2616](https://github.com/mmistakes/minimal-mistakes/pull/2616)
+ Fix grid `entries_layout` in home.html to ensure proper layout and display of content. [#2616](https://github.com/mmistakes/minimal-mistakes/pull/2616)

284-285: Clarify enhancement description.