Skip to content

docs: fix broken link, grammar, and typos across documentation - #668

Open
sarthakkaushik927 wants to merge 1 commit into
containers:mainfrom
sarthakkaushik927:fix/docs-typos
Open

docs: fix broken link, grammar, and typos across documentation #668
sarthakkaushik927 wants to merge 1 commit into
containers:mainfrom
sarthakkaushik927:fix/docs-typos

Conversation

@sarthakkaushik927

Copy link
Copy Markdown

Fixes #667

This PR resolves several typos and a broken relative link across the documentation and README.

Changes Included:

docs/index.md

  • Fixed broken link: Changed [installation instructions](docs/installation) to (installation.md) on line 22 to prevent Docusaurus from routing incorrectly to /docs/docs/installation.
  • Fixed grammar: Corrected the possessive pronoun typo "it's published port" to "its published port" on line 104.
  • Fixed grammar: Added missing article to change "running remote Podman client" to "running a remote Podman client" on line 137.

docs/installation.md

  • Fixed typo: Added a missing space to change "pkginstaller" to "pkg installer" on line 33.
  • Fixed grammar: Removed duplicate preposition to change "in the default in the" to "by default in the" on line 98.

README.md

  • Fixed typos: Corrected misspelled file references:
    • "globa.ts" -> "global.ts" (Line 59)
    • "typs.d.ts" -> "types.d.ts" (Line 82)
    • "docusarus" -> "docusaurus" (Line 94)

Signed-off-by: sarthakkaushik927 <sarthakkaushik927@gmail.com>
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.

docs: fix broken link, grammar, and typos across documentation

1 participant