docs: weights and frontmatter 3rd attempt #2001

bandantonio · 2025-07-24T19:51:16Z

Description

Related issue(s)
See also asyncapi/website#4269

Summary by CodeRabbit

Documentation
- Updated document titles to use hyphens instead of colons for consistency.
- Added front matter metadata (title and weight) to several documentation files for improved organization and navigation.

…tionalization guide

coderabbitai · 2025-07-24T19:51:25Z

Walkthrough

This update introduces front matter metadata (title and weight) to several Markdown documentation files and standardizes document titles by replacing colons with hyphens. No changes were made to the main content, structure, or logic of the affected documents.

Changes

Files	Change Summary
docs/COC-incident-resolution-procedures.md, docs/CODE_OF_CONDUCT_COMMITTEE.md, docs/community-glossary.md	Added YAML front matter with `title` and `weight` fields to the top of each document.
docs/020-governance-and-policies/PROJECT_FUNDING.md, docs/030-project-vision-strategy-goals/2025_marketing_strategy.md	Standardized document titles by replacing colons with hyphens in front matter and headings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

docs: update/add weights and frontmatter for community docs #1975: Also focuses on adding or updating front matter metadata in Markdown documentation files, directly relating to this PR's documentation structure and metadata changes.

Suggested labels

ready-to-merge

Suggested reviewers

derberg
asyncapi-bot-eve
thulieblack

Poem

Hop, hop, hop—front matter in place,
Titles and weights now set with grace.
Hyphens replace the colons’ reign,
Docs are tidy—nothing arcane!
A rabbit’s work is never done,
But metadata tweaks are rather fun.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

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

✨ 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

🪧 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.

bandantonio · 2025-07-24T19:54:05Z

@thulieblack Let's try one more time 🤞

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/020-governance-and-policies/PROJECT_FUNDING.md (1)
6-6: Promote H2 to H1 for consistency with other pages
After a front-matter block, most pages start with a single-# heading so the generated page title matches the metadata. Leaving this as ## may down-rank the headline and break automated ToC extraction.
-## Enhancing Event-Driven Architectures - Support AsyncAPI Initiative
+# Enhancing Event-Driven Architectures - Support AsyncAPI Initiative
docs/community-glossary.md (1)
6-8: Add a top-level heading to avoid a blank title in rendered output
Because the file starts straight with body text, some generators display an empty title. Consider inserting an H1 that mirrors the front-matter title.
 🚧 This document is under construction.
+
+# Community Glossary

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 21f8088 and 8962c22.

📒 Files selected for processing (5)

docs/020-governance-and-policies/PROJECT_FUNDING.md (1 hunks)
docs/030-project-vision-strategy-goals/2025_marketing_strategy.md (1 hunks)
docs/COC-incident-resolution-procedures.md (1 hunks)
docs/CODE_OF_CONDUCT_COMMITTEE.md (1 hunks)
docs/community-glossary.md (1 hunks)

🔇 Additional comments (5)

docs/020-governance-and-policies/PROJECT_FUNDING.md (1)

1-4: Front-matter looks correct – no blocking issues.
The YAML block parses cleanly and the weight (80) continues to fit the existing ordering convention.

docs/community-glossary.md (1)

1-4: Metadata added and parses fine – no blockers.
weight: 997 slots the page just ahead of the CoC docs that follow.

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

2-2: Title tweak aligns with new naming style – looks good.
No further action needed.

docs/CODE_OF_CONDUCT_COMMITTEE.md (1)

1-4: Front-matter validates & ordering (weight 998) is coherent.
Good to go.

docs/COC-incident-resolution-procedures.md (1)

1-4: Front-matter block added correctly – no syntax issues detected.
weight: 999 will place this page last within its section, matching intent.

thulieblack · 2025-07-25T08:02:31Z

/rtm

thulieblack · 2025-07-25T08:20:12Z

@bandantonio based on asyncapi/website#4274 (comment)

bandantonio · 2025-07-25T20:52:49Z

@thulieblack 😔 Sorry, I was 100% sure that I committed those changes.

I hope this will be the final attempt #2005

aeworxet · 2025-07-28T11:25:51Z

@asyncapi/bounty_team

bandantonio added 7 commits July 24, 2025 00:12

docs(style guide): fix incorrect location of localization and interna…

94b30f0

…tionalization guide

docs: update weights after changing structure

fd7a88b

docs: update headings in section index pages

2746c7e

docs: fix coderabbit mentions

0f3de66

docs: fix errors during deployment to website

952571f

docs: fix coderabbit suggestions

d8890f6

docs: fix deployment errors

f8ec3d1

bandantonio requested review from derberg, asyncapi-bot-eve and thulieblack as code owners July 24, 2025 19:51

Merge branch 'master' into docs/weights-and-frontmatter

8962c22

coderabbitai bot reviewed Jul 24, 2025

View reviewed changes

thulieblack approved these changes Jul 25, 2025

View reviewed changes

asyncapi-bot added the ready-to-merge label Jul 25, 2025

asyncapi-bot merged commit c231cf6 into asyncapi:master Jul 25, 2025
13 checks passed

bandantonio mentioned this pull request Jul 25, 2025

docs: fix commented and stringified page weights #2005

Merged

bandantonio deleted the docs/weights-and-frontmatter branch July 25, 2025 20:52

asyncapi-bot added the bounty label Jul 28, 2025

aeworxet added this to Bounty Program Jul 28, 2025

aeworxet moved this to Completed in Bounty Program Jul 28, 2025

coderabbitai bot mentioned this pull request Jul 28, 2025

docs: update section and index pages within community section #2011

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: weights and frontmatter 3rd attempt #2001

docs: weights and frontmatter 3rd attempt #2001

Uh oh!

bandantonio commented Jul 24, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 24, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

bandantonio commented Jul 24, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

thulieblack commented Jul 25, 2025

Uh oh!

Uh oh!

thulieblack commented Jul 25, 2025

Uh oh!

bandantonio commented Jul 25, 2025

Uh oh!

aeworxet commented Jul 28, 2025

Uh oh!

Uh oh!

Uh oh!

docs: weights and frontmatter 3rd attempt #2001

docs: weights and frontmatter 3rd attempt #2001

Uh oh!

Conversation

bandantonio commented Jul 24, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

bandantonio commented Jul 24, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

thulieblack commented Jul 25, 2025

Uh oh!

Uh oh!

thulieblack commented Jul 25, 2025

Uh oh!

bandantonio commented Jul 25, 2025

Uh oh!

aeworxet commented Jul 28, 2025

Uh oh!

Uh oh!

bandantonio commented Jul 24, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)