docs(readme): give each H2 heading a single authoritative section by WomB0ComB0 · Pull Request #72 · resq-software/programs

WomB0ComB0 · 2026-09-21T15:48:17Z

## Configuration and ## Development each appeared twice in the README. A reader landing on the second copy cannot tell which one is authoritative — that is the defect this fixes. Caught by the new README checks in the org repo-standards workflow (warn-only today).

Configuration — merged

Both copies described the same thing: Anchor.toml plus version environment variables. The second was the coarser restatement and was also wrong: it documented SOLANA_CLI_VERSION, which appears nowhere in this repo (and admitted as much — "Not directly used"). The override actually honoured is SOLANA_VERSION, read by scripts/setup.sh and set as a Dockerfile ARG, and the kept section already documents it.

Dropped from the second copy:

the SOLANA_CLI_VERSION bullet (variable does not exist here)
**Anchor.toml**: Specifies program IDs for different clusters ... default provider settings (cluster URL, wallet) — already covered in more detail by the kept [programs.localnet] / [programs.devnet] and [provider] bullets
the ANCHOR_VERSION bullet — already in the kept section

Carried over: its one detail not covered anywhere else, the Anchor.toml [scripts] entrypoint, added as a bullet (test = "bash ./scripts/test.sh").

Development — renamed

These two genuinely cover different subjects, so nothing was merged. The first is implementation guidance (error handling, CPI, the .claude workflow, threat model); the second is how to validate the repo (scripts/test.sh, the crate-local integration targets). The second is renamed to ## Testing and Validation. No content moved or reworded.

Verification

Ran the README block of the org repo-standards checker against this clone:

before: 1 violation — README.md has duplicate H2 headings: ## Configuration ## Development
after: 0 violations

The README has no table of contents and no in-page anchor links (](#), so the rename breaks no link.

Summary by CodeRabbit

Documentation
- Added documentation for the [scripts] anchor test entry point.
- Renamed the “Development” section to “Testing and Validation.”
- Removed the standalone configuration section covering Anchor.toml settings and environment variables.

Two H2 headings each appeared twice, so a reader hitting the second copy could not tell which one was current. Configuration: both copies described Anchor.toml and version environment variables, so they were merged into the first. The second copy documented `SOLANA_CLI_VERSION`, a variable that appears nowhere in the repo — the override actually honoured by scripts/setup.sh and the Dockerfile is `SOLANA_VERSION`, which the kept section already documents. Its one detail not already covered, the Anchor.toml `[scripts]` entrypoint, is carried over as a bullet. Development: the two copies covered different things. The first is implementation guidance (error handling, CPI, AI tooling, threat model); the second is how to validate the repo (scripts/test.sh, integration targets), so it is renamed to "Testing and Validation". No content moved. The README has no table of contents or in-page anchor links, so no link needed updating.

coderabbitai · 2026-09-21T15:48:29Z

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 1d14bb44-41a4-4c31-a2a7-b7a81f38f2a9

📥 Commits

Reviewing files that changed from the base of the PR and between f3052e1 and c5a2c9a.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 4883242b-af28-404f-848f-9cc1d7dd20f7

📥 Commits

Reviewing files that changed from the base of the PR and between 6022d58 and f3052e1.

📒 Files selected for processing (1)

README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Walkthrough

The README now documents the anchor test script entrypoint, removes a duplicate configuration section, and renames the development section to Testing and Validation.

Changes

README documentation

Layer / File(s)	Summary
Configuration and testing documentation `README.md`	The `Configuration` section now defines the `[scripts]` `anchor test` entrypoint. The duplicate configuration section was removed. The `Development` heading was renamed to `Testing and Validation`.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

🚥 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 clearly summarizes the main README change: consolidating duplicate H2 headings into single authoritative sections.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

🛠️ Fix failing CI checks 💡

Commit to this branch
Create a new PR

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.}

github-actions · 2026-09-21T15:53:51Z

The audit of the changes in this pull request has been completed.

Summary:

The changes are restricted to documentation updates in .
Redundant 'Configuration' and 'Development' sections were consolidated.
A new authoritative 'Testing and Validation' section was created.
The modifications improve the clarity and structure of the documentation without affecting the codebase or security posture.

The audit passed with no issues found.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

localhost

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "localhost"

See Network Configuration for more information.

Generated by ai-auditor for issue #72 · ◷

github-actions · 2026-09-21T15:53:52Z

The audit of the changes in this pull request has been completed.

Summary:

The changes are restricted to documentation updates in README.md.
Redundant 'Configuration' and 'Development' sections were consolidated.
A new authoritative 'Testing and Validation' section was created.
The modifications improve the clarity and structure of the documentation without affecting the codebase or security posture.

The audit passed with no issues found.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

localhost

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "localhost"

See Network Configuration for more information.

Generated by ai-auditor for issue #72 · ◷

github-actions Bot added size/S Small PR (10-29 lines changed) C-Documentation Improvements or additions to documentation labels Sep 21, 2026

WomB0ComB0 mentioned this pull request Sep 21, 2026

fix(deps): bump rustls to 0.23.45 for RUSTSEC-2026-0285 #73

Merged

Merge branch 'main' into docs/readme-duplicate-h2-sections

c5a2c9a

WomB0ComB0 merged commit d625d4e into main Sep 21, 2026
23 checks passed

Navigation Menu

docs(readme): give each H2 heading a single authoritative section - #72

docs(readme): give each H2 heading a single authoritative section#72
WomB0ComB0 merged 2 commits into
mainfrom
docs/readme-duplicate-h2-sections

WomB0ComB0 commented Sep 21, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Sep 21, 2026 •

edited

Loading

Review skipped

Walkthrough

Changes

Uh oh!

github-actions Bot commented Sep 21, 2026

Uh oh!

github-actions Bot commented Sep 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

WomB0ComB0 commented Sep 21, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Configuration — merged

Development — renamed

Verification

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Sep 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Uh oh!

github-actions Bot commented Sep 21, 2026

Uh oh!

github-actions Bot commented Sep 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

WomB0ComB0 commented Sep 21, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Sep 21, 2026 •

edited

Loading