docs: fix commented and stringified page weights

[bandantonio]

Related issue(s)
See also #2001

Summary by CodeRabbit

• Documentation
  • Activated and standardized the "weight" metadata in multiple documentation files to improve document ordering and organization.
  • Updated one document to use an integer value for the "weight" field for consistency.

[coderabbitai]

Walkthrough

Comment markers were removed from the "weight" metadata fields in several markdown documents, activating these fields in the front matter. In one file, the "weight" value was also changed from a string to an integer. No other content or logic was modified.

Changes

Files	Change Summary
docs/000-onboarding/documentarian-onboarding-guide.md docs/000-onboarding/how-to-contribute.md docs/000-onboarding/where-to-contribute.md docs/030-project-vision-strategy-goals/ROADMAP.md docs/070-marketing/social-media-communication-guidelines.md	Uncommented "weight" metadata fields in front matter
docs/070-marketing/webinar_series_initiative.md	Changed "weight" value from string to integer in metadata

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A hop and a skip through the docs today,
Weight tags awakened, no longer tucked away.
Rabbits rejoice as metadata aligns,
Order restored in tidy front matter lines.
🐇✨
Now the docs can leap ahead,
With every weight value properly spread!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 50293d6 and 44b05fb.

📒 Files selected for processing (6)

• docs/000-onboarding/documentarian-onboarding-guide.md (1 hunks)
• docs/000-onboarding/how-to-contribute.md (1 hunks)
• docs/000-onboarding/where-to-contribute.md (1 hunks)
• docs/030-project-vision-strategy-goals/ROADMAP.md (1 hunks)
• docs/070-marketing/social-media-communication-guidelines.md (1 hunks)
• docs/070-marketing/webinar_series_initiative.md (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.

docs/000-onboarding/where-to-contribute.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/000-onboarding/how-to-contribute.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

🔇 Additional comments (6)

docs/070-marketing/webinar_series_initiative.md (1)

1-4: Front-matter weight converted to integer – verify site/tooling expectations

Switching weight from the string "20" to the number 20 is semantically correct for most static-site generators (e.g., Hugo) and avoids an unnecessary string→int conversion.
Please confirm that:

1. Other pages in the same section still use numeric weights (no stray quoted strings remain).
2. No downstream template logic explicitly casts the value to a string.

If both points hold, this change is safe.

docs/000-onboarding/documentarian-onboarding-guide.md (1)

1-4: Uncommented weight adds the page to the menu – check for ordering clashes

Activating weight: 30 will surface this (currently placeholder) page in navigation.
There is another file (docs/030-project-vision-strategy-goals/ROADMAP.md) with the same weight of 30. That’s allowed, but ordering among equal weights is undefined in some generators.

If the appearance order matters, consider making weights unique or adding menu: parameters.

docs/000-onboarding/how-to-contribute.md (1)

1-4: Weight 20 now active – ensure draft content is intentionally exposed

The page is still marked “🚧 under construction.” Activating the weight pushes it into public navigation immediately.
If that’s intentional, all good. If not, either keep it commented or add draft: true until the content is ready.

docs/070-marketing/social-media-communication-guidelines.md (1)

1-4: Weight 10 enabled – confirm consistency across marketing docs

Just like the other changes, this brings the page into the navigation tree. Double-check that no two sibling marketing pages now share the weight 10 and that the ordering feels right.

docs/030-project-vision-strategy-goals/ROADMAP.md (1)

1-4: Same weight as onboarding guide – verify desired ordering

weight: 30 duplicates the value used by documentarian-onboarding-guide.md. If deterministic ordering is important, increment one of them. Otherwise, no functional issues.

docs/000-onboarding/where-to-contribute.md (1)

3-3: weight front-matter un-commented – looks good

Activating weight: 10 aligns with the numeric pattern used across the docs and will let the site generator order the page correctly. No issues spotted.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[CBID2]

Looks good to me! :)

[thulieblack]

Lets try again

[thulieblack]

/rtm

[aeworxet]

@asyncapi/bounty_team