Skip to content

Conversation

lumirlumir
Copy link
Owner

This pull request makes several improvements and clarifications to the README.md for the textlint-rule-allowed-uris package. The main updates include clarifying documentation around URI pattern matching, improving example links, and updating configuration examples to include a new option.

Documentation improvements:

  • Updated the link to detailed Markdown examples to point directly to the "links" section for better navigation.
  • Clarified the language to state that only regular expressions are allowed for URI pattern matching, making the restriction explicit.

Configuration example updates:

  • Added the checkUnusedDefinitions: false option to all configuration examples to document this available setting. [1] [2] [3] [4]

@Copilot Copilot AI review requested due to automatic review settings August 26, 2025 08:32
Copy link
Contributor

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

This pull request improves the documentation in the README.md file for the textlint-rule-allowed-uris package. The changes enhance clarity around URI pattern matching and provide more complete configuration examples.

  • Updated external link to point directly to the "links" section for better navigation
  • Clarified that only regular expressions are allowed for URI pattern matching
  • Added checkUnusedDefinitions: false option to all configuration examples

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions github-actions bot added 🏷️ scope: * Auto-generated label based on Conventional Commits specification for GitHub release notes 🏷️ type: docs Auto-generated label based on Conventional Commits specification for GitHub release notes labels Aug 26, 2025
Copy link

Labels have been automatically applied based on the Conventional Commits specification.🏷️

Copy link

codecov bot commented Aug 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (5818eb3) to head (3834675).
⚠️ Report is 1 commits behind head on main.

@@            Coverage Diff            @@
##              main      #329   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          257       257           
  Branches         1         1           
=========================================
  Hits           257       257           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5818eb3...3834675. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@lumirlumir lumirlumir merged commit 4e744b4 into main Aug 26, 2025
26 checks passed
@lumirlumir lumirlumir deleted the docs-update-readme branch August 26, 2025 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ scope: * Auto-generated label based on Conventional Commits specification for GitHub release notes 🏷️ type: docs Auto-generated label based on Conventional Commits specification for GitHub release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant