-
Notifications
You must be signed in to change notification settings - Fork 41
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is neededroadmap
Milestone
Description
Feature Description
Auto-documentation in website docs, that is based on XML docs in Core package.
Also, maybe in design-docs we should use same approach for built-in components document, but I'm not sure about that.
Problem Statement
- We must write the same documentation at least three times - in XML, in design-docs and in website.
- Because of the first problem, these three versions of documentation can differentiate (as in docs(website):Extend properties of Select component. #245), so it will only confuse devs.
Proposed Solution
- Some script in c# that fetches XML generated docs and write it to JSON, then data/components.ts reads properties and other stuff from it.
- Maybe there is some lib (something like nudoq) or framework (maybe docfx, but not sure if it will fit in our case) to automize this process. Never worked with any of that, so not familiar with any lib/framework.
Alternatives Considered
No response
Additional Context
No response
Contribution
- I'd be willing to contribute this feature
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is neededroadmap