Skip to content

docs: add section navigation and break up the dense blocks in the README - #47

Merged
AlaskanTuna merged 1 commit into
mainfrom
docs/readme-density
Aug 25, 2026
Merged

docs: add section navigation and break up the dense blocks in the README#47
AlaskanTuna merged 1 commit into
mainfrom
docs/readme-density

Conversation

@AlaskanTuna

Copy link
Copy Markdown
Owner

Applies the README structure and density conventions from AGENTS.md. No claim was added or removed — this is a lossless reformat, verified by grepping every factual claim out of the old version and back into the new.

Navigation — the README had --- dividers but no way back up a ~490-line page:

  • <a id="top"></a> on the first line.
  • A right-aligned ↑ Back to top link at the foot of all 14 top-level sections.
  • An explicit <a id="..."></a> above every ## heading. All 14 lead with an emoji, and GitHub's auto-generated slug mishandles those — it drops the emoji but keeps the hyphen the space left behind, and a variation selector makes the result unpredictable. Any future link into these sections now has a stable target.

Density — four blocks were correct but unscannable:

Block Before After
The Problem One 448-char paragraph holding a claim and two counter-examples Claim, then the two options as bullets, then the gap
Known Limitations Four consecutive **Claim.** explanation bullets, up to 568 chars each Two-column table: limitation, detail and mitigation
Disclaimers Five consecutive bolded-lead-in bullets Two-column table, emoji retained as the visual index
Graphify note (Project Structure) One block stating three separate rules Lead sentence, then the three rules as bullets

Verified: every measured figure, vendor name, section reference and limitation from the old text is still present at the same count — flux heuristics, roof-edge segmentation, constrained re-optimisation, Klang Valley, Imagery: BASE, TNB RP4, defaults to 0%, Suruhanjaya Tenaga, Purlin spacing, MCB sizing, 60 seconds, shrink guard, and the rest. Prettier and typecheck pass.

https://claude.ai/code/session_01URDpaxhXyPLWnUQtvowNyM

@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5d4ccb72-8976-43da-93cf-5604092fbcdb


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AlaskanTuna
AlaskanTuna merged commit 8235e2f into main Aug 25, 2026
3 checks passed
@AlaskanTuna
AlaskanTuna deleted the docs/readme-density branch August 25, 2026 14:17
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