Skip to content

Conversation

@milanholemans
Copy link
Contributor

Fixes some docs inconsistencies for the Contributing guide.

Copilot AI review requested due to automatic review settings November 8, 2025 15:38
Copy link

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 PR improves the consistency and clarity of the documentation by standardizing file path formats, fixing formatting issues, and enhancing code examples.

  • Standardizes file paths from backslashes to forward slashes for cross-platform compatibility
  • Improves list formatting and indentation for better readability
  • Fixes typos and enhances error messages in code examples
  • Updates validation logic examples to be more concise and readable

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/docs/contribute/new-command/writing-the-docs.mdx Standardizes file paths to forward slashes, improves CSV output example with explicit boolean values instead of empty strings, enhances list formatting with proper indentation, and adds clarification about alphabetical sorting
docs/docs/contribute/new-command/unit-tests.mdx Adds missing file path in code block title, corrects typo from "occured" to "occurred", improves URL validation in test by using exact match instead of endsWith, and adds missing webUrl parameters
docs/docs/contribute/new-command/build-command-logic.mdx Enhances error messages with quoted URL values and periods, improves option validation logic to be more concise, adds note about alphabetical command sorting, and enhances verbose logging messages
docs/docs/contribute/expect-during-pr.mdx Adds "Successful docs build" to the list of automated checks
docs/docs/contribute/contributing-guide.mdx Contains an incomplete sentence that needs completion

@MartinM85
Copy link
Contributor

Could we also mention in the contributing guide that when creating a new command, it is necessary to check if the dictionary in eslint.config.mjs contains all the words from the command name?

@milanholemans
Copy link
Contributor Author

Could we also mention in the contributing guide that when creating a new command, it is necessary to check if the dictionary in eslint.config.mjs contains all the words from the command name?

Good idea 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants