Skip to content

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

Merged
hyperpolymath merged 2 commits into
mainfrom
fix/contributing-guide-content
Sep 19, 2026
Merged

hyperpolymath merged 2 commits into
mainfrom
fix/contributing-guide-content

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.

Mechanical repairs to the guide, each anchored on a known-broken form:

- unescaped \# -> #
- rebuilt the hard-wrapped setup block into one command per line
- replaced invalid `():` commit header
- dedented headings that rendered as code

No prose is rewritten; only the broken forms are corrected.
@coderabbitai

coderabbitai Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the contribution guide with clearer setup instructions and properly formatted section headings.
    • Added reproducible development guidance using Guix.
    • Documented verification commands for checking and testing changes.
    • Expanded repository structure and perimeter classification details.
    • Added branch naming examples and clarified Conventional Commits formatting, including optional bodies and footers.

Walkthrough

The contributor guide now documents Guix-based setup, verification commands, repository structure, contribution headings, branch naming, and Conventional Commits syntax.

Changes

Contributor guide

Layer / File(s) Summary
Development setup guidance
.github/CONTRIBUTING.md
Setup commands are separated. Guix replaces Nix as the recommended environment. Verification commands and a structured repository tree are included.
Contribution and commit guidance
.github/CONTRIBUTING.md
Section headings are correctly formatted. Branch naming examples and Conventional Commits guidance now include optional body and footer details.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: metadatastician

🚥 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 describes a real change: repairing the repository-structure tree rendering in .github/CONTRIBUTING.md.
Description check ✅ Passed The description accurately explains the documented tree repair and related formatting corrections in .github/CONTRIBUTING.md.

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 each command in line
Guix keeps the setup neat and fine
Branch names hop with careful form
Commit notes now weather every storm
The guide grows clear from root to vine

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

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.
@hyperpolymath hyperpolymath changed the title fix(docs): repair the contributing guide content defects fix(docs): render the repository-structure tree as a tree Sep 19, 2026
@hyperpolymath
hyperpolymath merged commit 0956aa8 into main Sep 19, 2026
19 of 24 checks passed
@hyperpolymath
hyperpolymath deleted the fix/contributing-guide-content branch September 19, 2026 17:43
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