add lint and link check workflow for docs

[gbarros]

No description provided.

[Copilot]

Pull Request Overview

This PR adds a GitHub Actions workflow for linting and link checking documentation files. The workflow runs on pushes and pull requests to the docs-glow-up branch, as well as on a weekly schedule.

• Creates a new workflow file with two jobs: ESLint for code linting and Lychee for link validation
• Configures the workflow to run on the docs-glow-up branch for both push and pull request events
• Sets up a scheduled run every Monday at 9 AM UTC to catch broken links over time

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[gemini-code-assist]

Summary of Changes

Hello @gbarros, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request establishes a new GitHub Actions workflow dedicated to improving the quality and integrity of the project's documentation. By integrating automated linting and comprehensive link checking, the workflow ensures that documentation remains consistent, well-formatted, and free of broken references, thereby enhancing the overall reliability and user experience for anyone consulting the project's guides and references.

Highlights

• New GitHub Actions Workflow: Introduces a new workflow named "Lint & Link Check" to automate quality checks for documentation.
• Documentation Linting: Implements an ESLint job to enforce code style and consistency within the documentation files.
• Broken Link Detection: Adds a link checker using lycheeverse/lychee-action to identify and prevent broken links in README.md, MDX, Markdown, and theme.config.tsx files.
• Workflow Triggers: Configures the workflow to run on pushes and pull requests to the docs-glow-up branch, as well as on a weekly schedule.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new GitHub Actions workflow for linting and link checking the documentation, which is a great addition for maintaining quality. My review includes suggestions to improve the workflow's triggers for efficiency, align the Node.js version with the project's dependencies, and pin action versions for better stability and security.