Skip to content

docs: fix two markdown formatting errors in README#1297

Closed
redstartechno wants to merge 1 commit into
gonka-ai:mainfrom
redstartechno:bugfix/readme-markdown-formatting
Closed

docs: fix two markdown formatting errors in README#1297
redstartechno wants to merge 1 commit into
gonka-ai:mainfrom
redstartechno:bugfix/readme-markdown-formatting

Conversation

@redstartechno

Copy link
Copy Markdown

What problem does this solve?

Two small Markdown errors in the top-level README.md render incorrectly. One breaks an
italic caption; the other puts invalid text into a copy-paste shell command in the
"Build the project" section.

How do you know this is a real problem?

  • Line 24 — the Diagram 1 caption opens emphasis with a single * but closes with **:
    *[Work in progress] Diagram 1. The Task flow [Source](docs/papers/InferenceFlow.png)**.
    The unbalanced markers mean the line does not render as intended italic.
  • Line 52 — inside the fenced code block under "2. Build the project", the clone
    instructions read cd gonka (or repo name)**. The trailing ** and the parenthetical
    are stray editing leftovers; a reader copying the block runs an invalid command.

How does this solve the problem?

  • Line 24: close the caption with a single *.
  • Line 52: reduce the command to cd gonka.

What risks does this introduce? How can we mitigate them?

None. This is a documentation-only change with no runtime behavior impact. The change is
confined to README prose/formatting, so blast radius is a single file.

How do you know this PR fixes the problem?

Verified the rendered Markdown: the caption now renders as a single italic line, and the
code block now shows a clean, copy-pasteable cd gonka. See the before/after diff below.

Which components are affected?

README.md only.

Testing & evidence

No code paths changed; automated tests are not applicable to this documentation-only change.

@@ The Task flow caption (line 24)
-*[Work in progress] Diagram 1. The Task flow [Source](docs/papers/InferenceFlow.png)**
+*[Work in progress] Diagram 1. The Task flow [Source](docs/papers/InferenceFlow.png)*

@@ Build the project / clone block (line 52)
 git clone https://github.com/gonka-ai/gonka.git
-cd gonka (or repo name)**
+cd gonka

- line 24: close italic caption with a single * (was **), fixing unbalanced emphasis

- line 52: drop stray '(or repo name)**' from the clone code block so the command is clean
@redstartechno

Copy link
Copy Markdown
Author

Closing in favor of #1306, which combines this and the other docs fixes into a single PR per the maintainer's request. Thanks!

@redstartechno redstartechno deleted the bugfix/readme-markdown-formatting branch June 4, 2026 20:18
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.

1 participant