Suggestion: Change how site docs are generated
See original GitHub issueIs your feature request related to a problem? Please describe.
I’ve noticed there are many instances of documentation missing for public parameters in code and a difference in the documentation on parameters that are documented in code and the site.
Describe the solution you’d like
I’m wondering if we should make the site’s documentation generated from reading the documentation comments on the code itself so they always match? I’ve never done it before, but I know tools generate whole sites with the comments so it should be possible to read them and use them how we want.
Additional context
N/A
Automation Progress
Documentation Page Migrated & Checked - English
- Overview
- Button
- Icon
- Typography
- Divider
- Grid
- Layout
- Space
- Affix
- Breadcrumb
- Dropdown
- Menu
- PageHeader
- Pagination
- Steps
- AutoComplete - Base class properties not showing docs
- Cascader - Base class properties not showing docs
- Checkbox - not all properties are documenting. Generic is causing problems.
- DatePicker
- Form
- Input - Docs from generic base class not showing
- InputNumber
- Mentions
- Radio
- Rate
- Select
- Slider
- Switch
- TimePicker
- Transfer
- TreeSelect
- Upload
- Avatar
- Badge
- Calendar
- Card
- Carousel
- Collapse
- Comment
- Descriptions
- Empty
- Image
- List
- Popover
- Segmented
- Statistic - not all properties getting documentation. Prob affected by something in the “issues found” below
- Table - missing a lot of property summaries
- Tabs
- Tag
- Timeline
- Tooltip
- Tree
- Alert
- Drawer
- Message - done except methods docs
- Modal
- Notification
- Popconfirm
- Progress
- Result
- Skeleton
- Spin
- Anchor
- BackTop
Small Things Found On The Way
- Fix display of OneOf - missing types…just displays OneOf
- Adjust style of methods docs
- Getting XML documentation of methods is not being easy - the format of generics is different than just doing
.FullName
-
<inheritdoc />
not inheriting
Documentation Translated
This will take more investigation work to implement and we may want to split it into a separate effort. We could implement multiple languages for now by linking a file with the translation in the XML with a custom element.
- Decide on way to do it
- Decide how to allow overriding translation if automated is bad
- Implement automated translation w/ way to override
Possible Improvements
Some things that may be nice to implement in the future
- Remove inherited parameters from documentation and instead show a message like “Inherits API of SuchAndSuch”. It would save space.
- Link
<see cref="AntDesign.RenderMode"/>
to github for file or a page on the site for the file
Issue Analytics
- State:
- Created a year ago
- Comments:15 (15 by maintainers)
Top GitHub Comments
Update: All English documentation is complete and generating. Will be looking at the translation soon.
good news 👍 welcome back!