adobe / adobe/jsonschema2md

Additional fields meta schema / JSON Schema linting rules?

Open
#115 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
724
Forks
150
Avg merge
18h 22m
Merged PRs (30d)
4

Description

Background:
I work on JSON Schema the specification.
I'm developing a "JSON Schema Linter" rule listing, and collaborating with an existing tool for linting.

I've been further testing jsonschema2md, and found that using my existing schemas, I've encountered issues such as the main readme.md didn't include links to the files, which was because my schemas had no title.

Linting, to check the schemas have a title, would be useful, right?
You could add a warning or even enable via option, a mode which errors should specific linting rules fail.

It would be super if you could create one of or both of the following.

- A meta-schema for the additional fields you've added to make more useful documentation
- A list of linting rules which would be useful to this tool

Contributor guide

Open the contributing guide

Research direction

Start by reviewing jsonschema2md's current handling of schemas without titles and how the generated README links files. Clarify whether the work should deliver an additional-fields meta-schema, a list of linting rules, or both; done means a documented, agreed scope with corresponding behavior or artifacts.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.