adobe / adobe/jsonschema2md

Organise generated markdown into folders

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

Description

Currently when you have a large json schema file, alot of markdown files will be generated all contained within the single folder. In some cases this can easily become hundreds if not thousands of files. To improve organisation there should be an option to Organise the generated markdown files into folders based on the type they belong to. With this change the generated docs are easily browsable and presentable on websites etc.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named in the issue. Start by locating the entry point that generates Markdown and handles its output path, then inspect how generated files are currently grouped. Done means an option organizes generated Markdown into folders based on the types they belong to while preserving usable documentation output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.