adobe / adobe/xdm

Building docs for /extensions

Open
#502 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
266
Forks
380
Avg merge
5d 8h
Merged PRs (30d)
9

Description

I can build docs for the schemas under /schemas just fine with:
`jsonschema2md -o docs/reference -d ./schemas`

How do I build the docs for /extensions without copying over the /schemas sub-directories into /extensions?

I have tried a few different iteration including:
`jsonschema2md -o docs/reference -d ./extensions`
`jsonschema2md -o docs/reference -d ./`
`jsonschema2md -o docs/reference -d extensions/`

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing jsonschema2md command that builds docs from ./schemas and compare it with the /extensions directory layout. Investigate how jsonschema2md handles those directories without copying schema subdirectories, using docs/reference as the output target. Done means documenting or enabling a working command for building /extensions documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
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.