Incorrect references in "Objects" section of README.md in examples
- Dominant language
- JavaScript
- Stars
- 724
- Forks
- 150
- Avg merge
- 18h 22m
- Merged PRs (30d)
- 4
Description
If you look at the file `README.md` file in https://github.com/adobe/jsonschema2md/blob/master/examples/docs/README.md you will see in the Objects section references to `Simple` that look like this:
```markdown
- [Simple](./complex-properties-simple.md "This is a very simple example of a JSON schema") – `https://example.com/schemas/simple#/properties/refnamed`
- [Simple](./complex-properties-simple-1.md "This is a very simple example of a JSON schema") – `https://example.com/schemas/simple#/properties/refrefed`
- [Simple](./complex-properties-refobj-properties-simple.md "This is a very simple example of a JSON schema") – `https://example.com/schemas/simple#/properties/refobj/properties/foo`
- [Simple](./complex-properties-refnestedobj-properties-refobj-properties-simple.md "This is a very simple example of a JSON schema") – `https://example.com/schemas/simple#/properties/refnestedobj/properties/refobj/properties/foo`
```
The last link works fine as the file `./complex-properties-refnestedobj-properties-refobj-properties-simple.md` is generated. But the first 3 links don't work as the 3 files reference there, `./complex-properties-simple.md`, `./complex-properties-simple-1.md` and `./complex-properties-refobj-properties-simple.md` do not exist and are not generated.
I'm not sure if the links are wrong, or if the files were not generated, but either way, something is wrong.
Contributor guide
Research direction
Start with examples/docs/README.md and compare the three broken links with the generated example files named in the issue, including complex-properties-refnestedobj-properties-refobj-properties-simple.md. Trace the examples documentation generation entry point to determine whether the links or generation output is incorrect. Done means the Objects section contains only links to files that are generated and resolve correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, markdown
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100