Skip to content

Grammar fixes needed in docs/intro.mdx #36

Closed

Description

@bcastets-robotiq

Context

Raised during review of robotiq/.github#7, which snapshots this page's content into a test fixture (scripts/fixtures/intro.mdx). The grammar issues below are in the live page's own text, not the fixture — flagged there because that's where the diff happened to surface them.

Suggested fixes

  1. "Lots of software tools are available to work with Robotiq products. Some of those tools are developed and maintained by Robotiq and some other by the community of developers." → "Many software tools are available for working with Robotiq products. Some are developed and maintained by Robotiq, others by the developer community."
  2. "You will find in this documentation website the documentation for the software tools developed and maintained by Robotiq as well as reference to the software tools developed by the community." → "This site documents the software tools developed and maintained by Robotiq and references those developed by the community."
  3. "please refer to the corresponding Hardware manual available on Robotiq support website" → "please refer to the corresponding hardware manual on the Robotiq support website" (missing "the", and "Hardware" shouldn't be capitalized).
  4. "a sitewide Stable / Development (main) switcher, at the top of every page, covering every Robotiq-maintained tool" → "a sitewide Stable / Development (main) switcher at the top of every page that covers every Robotiq-maintained tool."
  5. "the only version this site makes any compatibility commitment about" → "the only version for which this site makes any compatibility commitment."
  6. "Here below is a summary about available tools." → "Below is a summary of the available tools."
  7. "an official Robotiq maintained driver" → "an official Robotiq-maintained driver" (missing hyphen; matches the "Robotiq-maintained" spelling elsewhere on the same page).

All in docs/intro.mdx. Once fixed, scripts/fixtures/intro.mdx in robotiq/.github should be refreshed from the live page to match.

Credit: @ebarnett3, via PR review.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions