ToolJet icon indicating copy to clipboard operation
ToolJet copied to clipboard

[docs]: Update the documentation for the Timer Component

Open PriteshKiri opened this issue 4 months ago • 7 comments

Summary

The entire URL of the documentation with the issue

https://docs.tooljet.com/docs/widgets/timer

Formatting updates:

  • Update the formatting based on the latest guidelines.
  • For each h2 (created using ##), remove 24px padding-bottom. The div that wraps up the h2 headers and the section below the header should only have a "padding-top" of 24px and no "padding-bottom".

Content updates:

  • Add a more descriptive introduction
  • Replace the word "widget" with "component" wherever applicable.
  • Layout Table
    • Replace the header "Layout" with "Devices"
    • Update the Description and Expected Value columns reference
  • Add a divider before the "Styles" section reference
  • Update the description in the Events table reference
  • Styles Table
    • Update the styles table with three headers - Property, Description, Configuration Options reference
    • Update the content of the style table reference
    • Include box-shadow under the Styles table reference

The changes are to be implemented in two files - Next - ToolJet/docs/docs/widgets/timer.md Version 2.50.0 (LTS) - ToolJet/docs/versioned_docs/version-2.50.0-LTS/widgets/timer.md

The deadline for this task is 3 days from the day of the assignment. Please feel free to reach out to us in our Slack community if you have any questions.

If the issue is confirmed, would you be willing to submit a pull request?

No

Code of Conduct

  • [X] I agree to follow the ToolJet Code of Conduct

PriteshKiri avatar Sep 30 '24 17:09 PriteshKiri