Skip to content

Link to Directory Layout manual from README - #10

Merged
koriym merged 1 commit into
1.xfrom
trim-readme
Apr 20, 2026
Merged

koriym merged 1 commit into
1.xfrom
trim-readme

Conversation

@koriym

@koriym koriym commented Apr 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds a single link to the new Directory Layout convention page under the README's Learn More section, so skeleton visitors can jump to the canonical "where does what go" reference.

Link target: be-framework.github.io#24.

Motivation

Closes #7. The issue originally proposed per-directory READMEs inside the skeleton; the manual's convention page covers the same ground in one canonical, i18n-ready location, so the skeleton itself stays minimal.

Test plan

  • GitHub renders the new link under Learn More.
  • The Directory Layout link resolves (once be-framework.github.io#24 merges).

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Apr 20, 2026 •

Copy link
Copy Markdown

Warning

Rate limit exceeded

@koriym has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 18 minutes and 8 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 18 minutes and 8 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0b7c5d6d-989a-4892-b7da-93be79e4a354

📥 Commits

Reviewing files that changed from the base of the PR and between 251ab12 and fb0db96.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch trim-readme

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 and usage tips.

@koriym koriym changed the title Trim README to intro + Learn More; link to Directory Layout manual Link to Directory Layout manual from README Apr 20, 2026
Adds one line under Learn More pointing at the new convention
page in the Be Framework manual.

Closes #7.
@koriym
koriym merged commit 304bfa5 into 1.x Apr 20, 2026
1 check passed
@koriym
koriym deleted the trim-readme branch April 20, 2026 08:51
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.

Example-driven skeleton: per-dir README + reference examples for LogContext / Being / Moment

1 participant