fix: topic table not rendering on GitHub

[izolyte]

What & why

GitHub's markdown parser breaks table rendering when an HTML comment sits
between the header separator and data rows. Both README.md and
docs/CONVENTIONS.md had <!-- TOPICS:START --> in that position, so the
topic tables rendered as raw text instead of a table.

Closes #1

Changes

• README.md, docs/CONVENTIONS.md: moved <!-- TOPICS:START --> to
  before the table header row, so the full table is inside the marker block
• scripts/sync-topics.sh: added the header rows (| Prefix | Topic | and
  |--------|-------|) into table_block so regeneration doesn't strip them

Summary by CodeRabbit

• Documentation

  • Enhanced auto-generated topic tables to include complete headers and column separators from the start, ensuring consistent, properly formatted tables across all documentation.

• Chores

  • Updated topic table generation script initialization to include table headers and separators upfront, improving consistency in generated documentation.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: dce7998f-2ebe-4f9d-b905-86814ee03131

📥 Commits

Reviewing files that changed from the base of the PR and between 973d5de and e5e7cb9.

📒 Files selected for processing (3)

• README.md
• docs/CONVENTIONS.md
• scripts/sync-topics.sh

---

📝 Walkthrough

Walkthrough

The scripts/sync-topics.sh script now initializes table_block with the Markdown table header and separator rows instead of an empty string. The TOPICS:START marker comment in README.md and docs/CONVENTIONS.md is repositioned to appear before the table header rows rather than after them.

Changes

Topics table marker and header fix

Layer / File(s)	Summary
Script initialization and docs marker alignment scripts/sync-topics.sh, README.md, docs/CONVENTIONS.md	table_block is pre-seeded with `

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A table once hid its header away,
The marker came after — a GitHub dismay!
I hopped to the script, moved the comment up high,
Now columns shine proudly beneath the clear sky.
Raw text be gone, let the table display! 🥕

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix: topic table not rendering on GitHub' accurately and concisely describes the main change—fixing a table rendering issue in GitHub documentation.
Linked Issues check	✅ Passed	All code changes directly address the linked issue #1: relocating HTML comments in README.md and docs/CONVENTIONS.md, and updating scripts/sync-topics.sh to include table headers, restoring proper markdown table rendering on GitHub.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to fixing the table rendering issue—modifying markdown files and the sync script to ensure tables render properly on GitHub, with no unrelated modifications detected.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/topic-table-rendering

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}