Skip to content

Avoid duplicating metadata? Proposed approach: Metadata is not limited to yaml. #2

@chipbite

Description

@chipbite

Hello! Feedback/suggestion - very short, not intended to be impolite, just concise.

Suggested Goal principles:

  • Do not duplicate metadata.
    • Why? Duplication is noisy and not slim, which is (IMO) the inverse of what adrs aspire to be
  • Metadata is not limited to yaml frontmatter. Data stored by convention is also first class metadata.
    • E g: Metadata stored in filename, in specific locations in file (first heading).

Suggested / example changes:

  • Do not duplicate ADR id both in filename and in yaml frontmatter.
    • Idea: If a processor needs to read yaml frontmatter, offer an intermediate build step to create the format required by that processor
  • Do not duplicate ADR title in both filename, first heading and yaml frontmatter.
    • Force balance: No markdown renderer will render title as first heading, so that duplication is hard to remove.
    • Idea: remove title in yaml frontmatter

It may be that there are needs that I did not consider - but considering how nice the tool seems, I hope that this can be removed.

Best regards!
/marcus

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