question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Suggestion: Change how site docs are generated

See original GitHub issue

Is 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:open
  • Created a year ago
  • Comments:15 (15 by maintainers)

github_iconTop GitHub Comments

2reactions
kooliokeycommented, Jan 9, 2023

Update: All English documentation is complete and generating. Will be looking at the translation soon.

0reactions
ElderJamescommented, Dec 6, 2022

good news 👍 welcome back!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Suggest changes | GitLab
In the comment toolbar, select Insert suggestion ( ). GitLab inserts a pre-populated code block into your comment, like this: ```suggestion:-0+0 ...
Read more >
Incorporating feedback in your pull request
To apply the change in its own commit, click Commit suggestion. Screenshot of a review comment with a suggestion. · To add the...
Read more >
Suggest edits in Google Docs - Computer
Suggest changes to a file · At the top right, click Editing edit . · From the drop-down, select Suggesting add suggestion ....
Read more >
Google Docs: Using Suggestion Mode to Track Changes
To track changes in Google Docs, you have to switch from Editing mode to Suggestion mode. Click the pencil icon underneath the Share...
Read more >
Customize query suggestions in SharePoint search
To create query suggestions in SharePoint search​​ On the search administration page, select Query Suggestion Settings. Open a text editor of ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found