Skip to content

📝 Update README.md#1422

Merged
harehare merged 1 commit intomainfrom
doc/update-readme
Mar 11, 2026
Merged

📝 Update README.md#1422
harehare merged 1 commit intomainfrom
doc/update-readme

Conversation

@harehare
Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings March 11, 2026 12:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the top-level documentation in README.md to reflect newer GitHub Actions usage and expanded ecosystem links.

Changes:

  • Bumps the GitHub Actions example to actions/checkout@v6.
  • Adds new language binding links for Java and Go.
  • Adjusts external tool links for mq-check and mq-lsp to point at their README files.

Comment on lines +378 to +382
- [mq-check](https://github.com/harehare/mq/tree/main/crates/mq-check/README.md) - A syntax and semantic checker for mq files.
- [mq-conv](https://github.com/harehare/mq-conv) - A CLI tool for converting various file formats to Markdown.
- [mq-docs](https://github.com/harehare/mq-docs) - A documentation generator for mq functions, macros, and selectors.
- [mq-edit](https://github.com/harehare/mq-edit) - A terminal-based Markdown and code editor with WYSIWYG rendering and LSP support.
- [mq-lsp](https://github.com/harehare/mq/tree/main/crates/mq-lsp) - Language Server Protocol (LSP) implementation for mq query files, providing IDE features like completion, hover, and diagnostics.
- [mq-lsp](https://github.com/harehare/mq/tree/main/crates/mq-lsp/README.md) - Language Server Protocol (LSP) implementation for mq query files, providing IDE features like completion, hover, and diagnostics.
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

The GitHub URL uses tree/.../README.md, which is intended for directories and may 404 or show a directory listing. For linking directly to a file, switch to blob/main/crates/mq-check/README.md (and similarly for mq-lsp) to ensure the links work consistently with the rest of the README (e.g., the editors/neovim/README.md link uses blob).

Copilot uses AI. Check for mistakes.
Comment on lines 162 to 170
### GitHub Actions

You can use mq in your GitHub Actions workflows with the [Setup mq](https://github.com/marketplace/actions/setup-mq) action:

```yaml
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- uses: harehare/setup-mq@v1
- run: mq '.code' README.md
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

This updates the Actions snippet to actions/checkout@v6, but the same snippet in docs/books/src/start/install.md still uses actions/checkout@v4, so the documentation is now inconsistent. Please update the book page to match, or (if v6 isn’t intended there) revert this README change to keep them in sync.

Copilot generated this review using guidance from repository custom instructions.
@harehare harehare merged commit 22c04ab into main Mar 11, 2026
8 checks passed
@harehare harehare deleted the doc/update-readme branch March 11, 2026 12:37
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.

2 participants