docs: add section navigation and break up the dense blocks in the README - #47
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 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:
**Claim.** explanationbullets, up to 568 chars eachVerified: 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