Duplicated information in generated output
- Dominant language
- JavaScript
- Stars
- 724
- Forks
- 150
- Avg merge
- 18h 22m
- Merged PRs (30d)
- 4
Description
### Expected Behaviour
Type of field only reported once. And type section is compact in the generated output. Preferable a table format always for the required, type, defined location and so on. Currently the output ends up very verbose, for very simple schema.
```
`raw`
* is required
* cannot be null
* defined in: [Configuration]()
### raw Type
`string[]`
```
### Actual Behaviour
Type of a node is reported in multiple sections.
```
`raw`
* is required
* Type: `string[]`
* cannot be null
* defined in: [Configuration]()
### raw Type
`string[]`
```
### Reproduce Scenario (including but not limited to)
#### Steps to Reproduce
```
"raw": {
"type": "array",
"items": { "type": "string" }
}
```
#### Platform and Version
#### Sample Code that illustrates the problem
#### Logs taken while reproducing problem
Contributor guide
Research direction
Start with the generated Markdown output and the reproduction schema in the issue, then trace the code path that renders a field's type and its type section. Confirm the change with the provided array-of-string example; done means the type is reported once and the generated output is more compact.
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
- Mostly clear
- Newbie friendliness
- 42/100