Skip to content

Conversation

@HazarBakir
Copy link

@HazarBakir HazarBakir commented Nov 11, 2025

Readme: Move Actor Model and Artificial Intelligence out of "Contents" Dropdown

Actor Model and Artificial Intelligence sections were stuck in the contents' dropdown.

We want to ensure high quality of the packages. Make sure that you've checked the boxes below before sending a pull request.

Not every repository (project) will require every option, but most projects should. Check the Contribution Guidelines for details.

  • The repo documentation has a pkg.go.dev link.
  • The repo documentation has a coverage service link.
  • The repo documentation has a goreportcard link.
  • The repo has a version-numbered release and a go.mod file.
  • The repo has a continuous integration process that automatically runs tests that must pass before new pull requests are merged.
  • Continuous integration is used to attempt to catch issues prior to releasing this package to end-users.

@avelino This is a documentation fix only, not a new package addition.
The quality checks are failing because they expect package links, but I'm
only fixing the README structure. Could you please review?

Please provide some links to your package to ease the review

  • forge link (github.com, gitlab.com, etc):
  • pkg.go.dev:
  • goreportcard.com:
  • coverage service link (codecov, coveralls, etc.):

Pull Request content

  • The package has been added to the list in alphabetical order.
  • The package has an appropriate description with correct grammar.
  • As far as I know, the package has not been listed here before.

Category quality

Note that new categories can be added only when there are 3 packages or more.

Packages added a long time ago might not meet the current guidelines anymore. It would be very helpful if you could check 3-5 packages above and below your submission to ensure that they also still meet the Quality Standards.

Please delete one of the following lines:

  • The packages around my addition still meet the Quality Standards.
  • I removed the following packages around my addition: (please give a short reason for each removal)

Thanks for your PR, you're awesome! 😎

Summary by CodeRabbit

  • Documentation
    • Improved README navigation and readability: adjusted section spacing, added and relocated "Back to top" links, and refined fold/section boundaries for clearer browsing.
    • Fixed minor markup and formatting issues (removed stray tags, reflowed section markers) to stabilize folding and navigation without altering content.
    • Minor wording tweak in a library description for clearer phrasing.

…ents" Dropdown

Actor Model and Artificial Intelligence sections were stuck in the contents' dropdown.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 11, 2025

Walkthrough

README.md: formatting-only edits — adjusted blank lines and list spacing, moved and reflowed </details> fold markers, and added/relocated "Back to top" links; no substantive content changes.

Changes

Cohort / File(s) Summary
README Documentation
README.md
Whitespace and blank-line adjustments; relocated and added "Back to top" links; reflowed and repositioned </details> folding markers; minor bullet/list formatting edits; adjusted section boundary markers.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single-file documentation-only changes; cosmetic reflow and tag placement.
  • Review focus: ensure </details> placements produce intended folding and that "Back to top" links render correctly.

Poem

🐰 I hopped through lines with careful, tiny feet,
Tucked tags in folds where wandering breaks meet.
Back-to-top springs placed neatly in a row,
A README polished — soft and swift I go.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: moving Actor Model and Artificial Intelligence sections out of a dropdown in the README, which aligns with the PR objectives and raw summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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.

@github-actions
Copy link

Automated Quality Checks (from CONTRIBUTING minimum standards)

  • Repo link: missing
  • pkg.go.dev: missing
  • goreportcard: missing
  • coverage: missing

These checks are a best-effort automation and do not replace human review.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56e2cfa and 3ecc14c.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
README.md

📄 CodeRabbit inference engine (AGENTS.md)

README.md: When modifying the Awesome list, keep categories with at least three entries
Descriptions in the Awesome list must end with a period
Avoid promotional copy; keep descriptions concise and neutral in the Awesome list
Do not remove existing list content unless removal is requested and justified

Files:

  • README.md
**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Keep documentation in English

Files:

  • README.md
{README.md,COVERAGE.md}

📄 CodeRabbit inference engine (AGENTS.md)

Align rendered documentation (README.md, COVERAGE.md, etc.) with behavior changes in main.go or helper packages

Files:

  • README.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: elymanuba
Repo: avelino/awesome-go PR: 5762
File: README.md:0-0
Timestamp: 2025-08-14T23:46:18.545Z
Learning: When reviewing contributions to the awesome-go repository, maintain a relaxed and less pedantic approach. Users may find overly strict feedback about formatting, alphabetical ordering, or description tone to be unnecessary. Focus on major issues rather than minor stylistic preferences.
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to {README.md,COVERAGE.md} : Align rendered documentation (README.md, COVERAGE.md, etc.) with behavior changes in main.go or helper packages
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to AGENTS.md : Update AGENTS.md whenever repository conventions change
📚 Learning: 2025-10-08T00:38:13.132Z
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to {README.md,COVERAGE.md} : Align rendered documentation (README.md, COVERAGE.md, etc.) with behavior changes in main.go or helper packages

Applied to files:

  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (2)
README.md (2)

211-214: Correctly scoped Contents fold.

Moving the closing

to end the Contents block only is right; “Actor Model” and “Artificial Intelligence” are no longer hidden.


225-225: Back-to-top link addition is consistent.

The section-level back-to-top link matches the pattern used elsewhere.

@HazarBakir
Copy link
Author

HazarBakir commented Nov 15, 2025

@avelino I've just fixed a bug in the Contents dropdown, and now I am failing on quality checks. Can I get a help about it please?

@hossein2039
Copy link

Warm code

@HazarBakir
Copy link
Author

HazarBakir commented Nov 19, 2025

@hossein2039 Sorry, I couldn't follow. What do you mean?

@HazarBakir
Copy link
Author

@avelino Hi! I'm getting quality check failures because the bot expects
package links (pkg.go.dev, goreportcard, etc.). However, this PR is only
a documentation fix - I'm not adding any new packages.

I simply moved "Actor Model" and "Artificial Intelligence" sections out
of the Contents dropdown where they were incorrectly nested.

Could you help override these quality checks or suggest how to proceed
with documentation-only PRs?

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants