Skip to content

fix(docs): render the repository-structure tree as a tree - #50

Merged
hyperpolymath merged 1 commit into
mainfrom
fix/contributing-guide-structure-tree
Sep 19, 2026
Merged

hyperpolymath merged 1 commit into
mainfrom
fix/contributing-guide-structure-tree

Conversation

@hyperpolymath

@hyperpolymath hyperpolymath commented Sep 19, 2026 •

Copy link
Copy Markdown
Owner

The "Repository Structure" block was hard-wrapped by the AsciiDoc→Markdown conversion, so the entire tree collapsed into a single paragraph and rendered as one run-on line.

Rebuilt from the block's own content:

  • depth recovered from the │ continuation bars that survived the wrap
  • the guide entry moved under .github/, where the guide actually lives
  • \# escapes unescaped, └── restored on the last entry of each group
  • the block fenced with ```text so it renders as a tree

Every annotation ("Perimeter 1-2" etc.) is preserved — nothing invented, nothing dropped.

The tree block was hard-wrapped by the AsciiDoc->Markdown conversion, so it
rendered as a paragraph rather than a tree, and it still listed
CONTRIBUTING.md at the repository root, where the guide no longer lives.

Rebuilt from the tree's own content: depth recovered from the `|` continuation
bars that survived the wrap, the guide entry moved under `.github/`, `#`
escapes unescaped, the last entry of each group restored to `└──`, and the
block fenced so it renders as a tree. Every annotation ("Perimeter 1-2") is
preserved - nothing is invented and nothing is dropped.
@coderabbitai

coderabbitai Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 5037d1c6-7ef7-4fd8-a7d1-86d957e4167c

📥 Commits

Reviewing files that changed from the base of the PR and between 477b042 and 28fb6f4.

📒 Files selected for processing (1)
  • .github/CONTRIBUTING.md

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

📜 Recent review details
⏰ Context from checks skipped due to timeout. (22)
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / rust-secrets
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: test (1.11)
  • GitHub Check: analyze (actions, none)
  • GitHub Check: test (1.10)
  • GitHub Check: Groove manifest check
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: Validate K9 contracts
  • GitHub Check: test (1.11)
  • GitHub Check: test (1.10)
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

23-50: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the repository structure documentation with a clearer multiline layout.
    • Documented the contribution guide’s location under the .github directory.
    • Added details about the contents of the .github directory.

Walkthrough

The contribution guide now presents the repository tree as a multiline text block. It places .github/CONTRIBUTING.md under .github/ and removes the former root-level entry.

Changes

Repository documentation tree

Layer / File(s) Summary
Contribution guide repository tree
.github/CONTRIBUTING.md
The repository tree now uses a multiline text block. The tree shows .github/CONTRIBUTING.md in .github/ and removes the root-level CONTRIBUTING.md entry.

Priority: ⬇️ Low

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

Change: Bug fix

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly identifies the documentation fix for the repository-structure tree and matches the main change.
Description check ✅ Passed The description explains the tree-rendering issue and the specific documentation changes made.

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

A rabbit checks the tree,
The branches now align,
.github holds its guide,
Each path is clear and fine,
No root leaf remains.

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

@hyperpolymath hyperpolymath changed the title fix(docs): rebuild the mangled repository-structure tree fix(docs): render the repository-structure tree as a tree Sep 19, 2026
@hyperpolymath
hyperpolymath merged commit 805d674 into main Sep 19, 2026
22 of 28 checks passed
@hyperpolymath
hyperpolymath deleted the fix/contributing-guide-structure-tree branch September 19, 2026 17:49
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