adobe / adobe/jsonschema2md

Local #ref definition page links are created with broken links

Open
#606 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
724
Forks
150
Avg merge
18h 22m
Merged PRs (30d)
4

Description

### Expected Behaviour
Links to #ref definition markdown files work

### Actual Behaviour
Broken links are created, so there is no way to navigate propertly to a #ref definition from where it is used in a higher level schema

### Reproduce Scenario (including but not limited to)
Create a schema with a local #ref definition.

#### Steps to Reproduce
Try to navigate to a the #ref definition "defined in:" in the higher level .md files

#### Platform and Version
latest

#### Sample Code that illustrates the problem

#### Logs taken while reproducing problem

Contributor guide

Open the contributing guide

Research direction

Reproduce the issue with a schema containing a local #ref definition, then inspect the generated higher-level .md files and their “defined in:” links. Done means links to local #ref definition markdown files resolve correctly and allow navigation from the schema where the reference is used.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
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.