Skip to content

fix: fix typos, formatting, and consistency issues in README#339

Open
vijaynallagatla wants to merge 1 commit intonats-io:mainfrom
vijaynallagatla:patch-1
Open

fix: fix typos, formatting, and consistency issues in README#339
vijaynallagatla wants to merge 1 commit intonats-io:mainfrom
vijaynallagatla:patch-1

Conversation

@vijaynallagatla
Copy link

@vijaynallagatla vijaynallagatla commented Feb 18, 2026

Add a Table of Contents, and fix few typos.

@vijaynallagatla vijaynallagatla changed the title Update README.md fix: update README.md Feb 18, 2026
@vijaynallagatla vijaynallagatla changed the title fix: update README.md fix: fix typos, formatting, and consistency issues in README Feb 18, 2026
@Jarema Jarema closed this Mar 4, 2026
@Jarema Jarema reopened this Mar 4, 2026
@github-actions
Copy link

github-actions bot commented Mar 4, 2026

PR Review: README typos, formatting, and consistency fixes

Summary

Documentation-only PR that adds a Table of Contents and fixes several typos and formatting issues in the README. Single commit, single file changed (+27/-9).

Changes Reviewed

Table of Contents (lines 10–21): Adds a well-structured ToC linking to existing sections. Anchor links match the actual headings. Looks correct.

Code fence language tags: Several bare ``` blocks changed to ```sh — good for syntax highlighting consistency.

Typo fixes — all correct:

  • "The are" → "There are"
  • "namspace" → "namespace"
  • "a a stream" → "a stream"

Link fix: Chart repo link updated from master to main branch — matches the actual default branch.

Inline comment moved to note block: The // Not required if running with --control-loop inline comment in a shell code block is moved to a proper > **Note**: blockquote above the code. This is a good fix — shell comments use #, not //, so the original was misleading.

Added descriptions:

  • Brief description added under "API Reference" heading.
  • Brief description added under "NATS Boot Config" heading.
    These are helpful for readers scanning the document.

Issues

None found. All changes are straightforward documentation improvements.

Verdict

LGTM — clean, low-risk documentation improvements. Recommend merge.

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.

2 participants