microsoft / microsoft/AdaptiveCards
[Tooling] Schema doc generating tool only generates docs for top level of host config schema.
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2k
- Forks
- 595
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 1
Description
Platform
What platform is your issue or question related to? (Delete other platforms).
Tooling
Details
Using the generate.cmd tool to generate the host config documentation only generates the top level of objects. For inputs, for example, the tool will generate documentation for InputsConfig, but not for the sub-objects LabelConfig, InputLabelConfig, and ErrorMessageConfig (see comments on #4580). This bug tracks improving the tool to generate those sub-objects.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with source/nodejs/spec-generator/generate.cmd and review the comments on #4580 to understand the current host config documentation generation. Confirm the generated output for InputsConfig, then verify that LabelConfig, InputLabelConfig, and ErrorMessageConfig are also documented when the issue is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nodejs
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100