Skip to content

Add recommended frontmatter fields to existing patterns #41

Closed

Description

@oskarth

Summary

The CI validation identified 34 warnings across existing pattern files that should be addressed to improve documentation quality and consistency.

Warnings to Address

Missing Recommended Frontmatter Fields

Most patterns are missing the following recommended fields:

  • layer - Specify L1/L2/offchain/hybrid
  • privacy_goal - One-line description of privacy objective
  • assumptions - Key trust/infrastructure assumptions
  • last_reviewed - Date of last review (YYYY-MM-DD)

Patterns with Missing Sections

A few patterns are missing required sections:

  • pattern-focil-eip7805.md - Missing "## Ingredients"
  • pattern-privacy-l2s.md - Missing "## Protocol"
  • pattern-shielding.md - Missing "## Protocol"
  • pattern-zk-derivative-delta.md - Missing "## Ingredients" and "## See also"

Unexpected Maturity Values

Some patterns use non-standard maturity values:

  • pattern-eil.md - Uses "ready" instead of standard values
  • pattern-focil-eip7805.md - Uses "not yet recommended"
  • pattern-lean-ethereum.md - Uses "research"
  • pattern-oif.md - Uses "ready"
  • pattern-private-iso20022.md - Uses "research"
  • pattern-zk-spv.md - Uses "research"

Recommended Actions

  1. Add missing frontmatter fields to all patterns following this format:
---
title: "Pattern: <name>"
status: draft|ready
maturity: experimental|pilot|production
layer: L1|L2|offchain|hybrid
privacy_goal: <one line description>
assumptions: <key trust/infrastructure assumptions>
last_reviewed: YYYY-MM-DD
---
  1. Add missing sections where identified

  2. Standardize maturity values to: experimental, pilot, or production

Benefits

  • Improved searchability and filtering by layer/privacy goal
  • Better understanding of pattern assumptions
  • Track pattern freshness with last_reviewed date
  • Consistent structure across all patterns

Related

Priority

Medium - These are warnings only and don't block PRs, but addressing them will improve documentation quality and make patterns more discoverable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions