Skip to content

[Fix] Improve README.md grammar, formatting, and license link #23152

Closed

Description

@adithya-naik

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

I can't find what I'm looking for

Description

This issue proposes a few minor but meaningful improvements to the README.md file to enhance clarity, grammar, and formatting.

🔧 Suggested Improvements:

  1. Grammar Fix

    • Original:
      "Click Give feedback on of every page in the docs."
    • Updated:
      "Click Give feedback on every page in the docs."
  2. Formatting Enhancement

  3. Minor Clarity Improvement

    • Original:
      "Feel free to send us pull requests and issues."
    • Updated:
      "We welcome your contributions—feel free to open pull requests or issues."
  4. Markdown Link Cleanup in Footer

    • Original:
      Copyright 2013-2025 Docker, Inc., released under the <a href="https://github.com/docker/docs/blob/main/LICENSE">Apache 2.0 license</a>.
    • Updated:
      Copyright 2013-2025 Docker, Inc., released under the [Apache 2.0 license](https://github.com/docker/docs/blob/main/LICENSE).

Location

https://github.com/docker/docs/blob/main/README.md

Suggestion

I suggest updating the README.md file to fix grammar, enhance formatting, and improve markdown consistency as described above. I would like to work on this issue and will open a pull request shortly.

Activity

  1. adithya-naik commented on Jul 24, 2025

    @adithya-naik
    ContributorAuthor

    I am assigning this issue to myself and will submit a pull request addressing the suggested changes shortly.

  2. sarahsanders-docker commented on Jul 24, 2025

    @sarahsanders-docker
    Contributor

    Thank you so much for opening a PR @adithya-naik! I am running the last of the CI checks on it now, and will merge shortly.

  3. adithya-naik commented on Jul 24, 2025

    @adithya-naik
    ContributorAuthor

    Thank you so much for reviewing it! Glad to contribute to the Docker docs. Looking forward to more contributions 🚀

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions