Skip to content

Updated the documentation for the Timeline Component - #10860

Merged
adishM98 merged 6 commits into
ToolJet:developfrom
Asymtode712:docs
Oct 4, 2024
Merged

Updated the documentation for the Timeline Component#10860
adishM98 merged 6 commits into
ToolJet:developfrom
Asymtode712:docs

Conversation

@Asymtode712

@Asymtode712 Asymtode712 commented Oct 1, 2024

Copy link
Copy Markdown
Contributor

Description

Closes #10847

This PR updates the documentation for the Timeline component in both the main and LTS versions of the ToolJet documentation.

Changes Made

  1. Improved Introduction

    • Added a more descriptive introduction to better explain the Timeline component's purpose and use cases.

  2. Updated Formatting

    • Applied the latest style guide recommendations to improve readability and consistency.

  3. Layout Updates

    • Renamed "Layout" section to "Devices" for clarity.
    • Updated the description and expected values in the Devices table.

  4. Styles Table Enhancements

    • Restructured the Styles table with new headers: Property, Description, and Configuration Options.
    • Added "Box Shadow" property to the Styles table.

  5. Removed Redundant Padding

    • Eliminated 24px padding-bottom from h2 headers and their sections to improve layout consistency.

  6. General Cleanup

    • Made minor adjustments to improve overall document structure and clarity.

Files Modified

  • docs/docs/widgets/timeline.md
  • docs/versioned_docs/version-2.50.0-LTS/widgets/timeline.md

@CLAassistant

CLAassistant commented Oct 1, 2024 •
edited
Loading

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@TooljetBot

TooljetBot commented Oct 1, 2024

Copy link
Copy Markdown
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

@RudraPratik30
RudraPratik30 self-requested a review October 3, 2024 10:45
@github-actions

github-actions Bot commented Oct 3, 2024

Copy link
Copy Markdown
Contributor

Deployment: https://tooljet-pr-10860.onrender.com
Dashboard: https://dashboard.render.com/static/srv-crv7bidds78s73a9sho0

RudraPratik30
RudraPratik30 requested changes Oct 3, 2024
View reviewed changes

@RudraPratik30 RudraPratik30 left a comment •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Asymtode712 please make the mentioned changes in both the versions.

Comment thread docs/docs/widgets/timeline.md Resolved
Comment thread docs/docs/widgets/timeline.md Resolved
Comment thread docs/versioned_docs/version-2.50.0-LTS/widgets/timeline.md Resolved
Comment thread docs/docs/widgets/timeline.md Resolved
Comment thread docs/docs/widgets/timeline.md Resolved
Comment thread docs/docs/widgets/timeline.md Resolved
@TooljetBot

TooljetBot commented Oct 3, 2024

Copy link
Copy Markdown
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: The AI Code Review Agent was unable to review this change because Bito workspace ToolJet is downgraded to the plan that doesn’t include Code Review Agent feature.

    Please coordinate with your workspace admin to request an upgrade to the 10X Developer Plan.

@Asymtode712

Asymtode712 commented Oct 3, 2024

Copy link
Copy Markdown
Contributor Author

@RudraPratik30 I have done the changes as requested by you, please review the changes and merge them if they are good to go

@TooljetBot

TooljetBot commented Oct 3, 2024

Copy link
Copy Markdown
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: The AI Code Review Agent was unable to review this change because Bito workspace ToolJet is downgraded to the plan that doesn’t include Code Review Agent feature.

    Please coordinate with your workspace admin to request an upgrade to the 10X Developer Plan.

@RudraPratik30

RudraPratik30 commented Oct 3, 2024

Copy link
Copy Markdown
Collaborator

Hey @Asymtode712, I think one of the reviews is yet to be resolved, please make the necessary changes and then I will forward the PR to the team, thanks!
Please check this: #10860 (comment)

@TooljetBot

TooljetBot commented Oct 3, 2024

Copy link
Copy Markdown
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: The AI Code Review Agent was unable to review this change because Bito workspace ToolJet is downgraded to the plan that doesn’t include Code Review Agent feature.

    Please coordinate with your workspace admin to request an upgrade to the 10X Developer Plan.

@Asymtode712

Asymtode712 commented Oct 3, 2024

Copy link
Copy Markdown
Contributor Author

Hey @Asymtode712, I think one of the reviews is yet to be resolved, please make the necessary changes and then I will forward the PR to the team, thanks! Please check this: #10860 (comment)

@RudraPratik30 Done!

@github-actions

github-actions Bot commented Oct 3, 2024

Copy link
Copy Markdown
Contributor

Deployment: https://tooljet-pr-10860.onrender.com
Dashboard: https://dashboard.render.com/static/null

RudraPratik30
RudraPratik30 previously approved these changes Oct 3, 2024
View reviewed changes
@RudraPratik30

RudraPratik30 commented Oct 3, 2024

Copy link
Copy Markdown
Collaborator

Hey @Asymtode712, thanks for contributing!
I have approved the changes from my end, now forwarding the PR to the team.
Your PR will be merged soon. Happy Coding!

@TooljetBot

TooljetBot commented Oct 4, 2024

Copy link
Copy Markdown
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: The AI Code Review Agent was unable to review this change because Bito workspace ToolJet is downgraded to the plan that doesn’t include Code Review Agent feature.

    Please coordinate with your workspace admin to request an upgrade to the 10X Developer Plan.

@TooljetBot

TooljetBot commented Oct 4, 2024

Copy link
Copy Markdown
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: The AI Code Review Agent was unable to review this change because Bito workspace ToolJet is downgraded to the plan that doesn’t include Code Review Agent feature.

    Please coordinate with your workspace admin to request an upgrade to the 10X Developer Plan.

@sonarqubecloud

sonarqubecloud Bot commented Oct 4, 2024

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@adishM98
adishM98 merged commit 029cf04 into ToolJet:develop Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adishM98 adishM98 adishM98 approved these changes
@RudraPratik30 RudraPratik30 RudraPratik30 left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[docs]: Update the documentation for the Timeline Component

6 participants

@Asymtode712 @CLAassistant @TooljetBot @RudraPratik30 @adishM98 @karan-rathod-316