Skip to content

Fix #3: JSON blocks could benefit from inline annotations #38

@RichardHightower

Description

@RichardHightower

Fix #3: JSON blocks could benefit from inline annotations

Severity: Low | Pillar: Writing Style | Impact: +1 point

Problem

Large JSON policy blocks lack inline comments explaining key fields

Location

SKILL.md:common patterns, references/*.md

Current Code

Raw JSON with explanatory text before/after but not inline

Suggested Fix

Add # comments within JSON (where supported) or JSONC format snippets for educational value

Part of Skill Grading Report

Powered by: SkillzWave.ai | SpillWave

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