docs: update markdown metadata and contributing guidelines

[mikepsinn]

Summary by Sourcery

Update markdown metadata guidelines and examples to clarify frontmatter requirements and enforce a description length limit.

Documentation:

• Require frontmatter description to be under 140 characters in CONTRIBUTING.md
• Add governance fields to frontmatter guidelines
• Adjust example markdown file to comply with new description length constraint
• Update markdown-metadata rule configuration to reflect the updated guidelines

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates markdown frontmatter standards by specifying a description length constraint in the contributing guidelines, refactoring an example file’s description to comply, and aligning linter rules accordingly.

Class diagram for updated Markdown frontmatter structure

classDiagram
    class MarkdownFrontmatter {
        +title: string
        +description: string (<140 chars)
        +published: boolean
        +date: date
        +tags: list<string>
        +editor: string
        +dateCreated: date
        +topic_id: string
        +canonical: boolean
    }

Loading

Flow diagram for updated markdown frontmatter validation process

flowchart TD
    A[Author writes Markdown file] --> B[Add YAML frontmatter]
    B --> C[Ensure mandatory fields: title, description, published, date, tags, editor, dateCreated]
    C --> D[Check description length < 140 characters]
    D --> E[Add governance fields: topic_id, canonical]
    E --> F[Submit for review]

Loading

File-Level Changes

Change	Details	Files
Specify max length for frontmatter description in contributing guidelines	Add “(under 140 characters)” to the description field requirements	community/CONTRIBUTING.md
Refactor example markdown description to meet updated guidelines	Shorten and quote the description to adhere to the 140-character limit	economic-models/dih-treasury-cash-flow-model.md
Align markdown metadata linter rules with new frontmatter standards	Update rule definitions to enforce the updated description requirement	.cursor/rules/markdown-metadata.mdc

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[github-actions]

Current Voting Result
Vote on this comment with 👍 or 👎.

Vote Summary:
0 👍
0 👎

Acceptance Criteria:

• 51% of weighted votes needs to be to approve
• 1 minimum # of unique voters required
• at least 720 minutes of voting

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}