chore: update component links to docs #79

mruknowme · 2024-11-15T00:53:36Z

PR Checklist

Please check if your PR fulfills the following requirements:

Docs have been added/updated (for bug fixes/features)

PR Type

What kind of change does this PR introduce?

Issue Number

Issue Number: #78

Does this PR introduce a breaking change?

Yes
No

Other information

Summary by CodeRabbit

Documentation
- Updated links in the flowbite-angular README to direct users to a new documentation structure for various UI components.
- Removed construction emoji from component names, indicating components are now stable and fully available for use.

vercel · 2024-11-15T00:53:40Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flowbite-angular	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 15, 2024 0:56am

coderabbitai · 2024-11-15T00:53:43Z

Walkthrough

The changes in this pull request focus on updating the README.md for the flowbite-angular library. The modifications include revising links to various UI component documentation to reflect a new structure on the official website. Additionally, the construction emoji has been removed from several component names, indicating that these components are now stable and fully available for use.

Changes

File Path	Change Summary
libs/flowbite-angular/README.md	Updated multiple links to point to new documentation structure under `flowbite-angular.com/docs/components/`. Removed construction emoji from component names indicating stability for components such as Buttons, Dropdowns, Modals, etc.

Possibly related issues

Update README links to docs #78: This issue requests an update to README links to point to the new documentation URLs, which aligns with the changes made in this PR.

Possibly related PRs

docs: add inherit component documentation #73: This PR involves documentation changes related to components in the flowbite-angular library, which is relevant to the updates made in this PR regarding component documentation links and statuses.

Poem

🐇 In the garden of code, links bloom bright,
Flowbite's components now shine with light.
No more construction, they're ready to play,
Documentation updated, hip-hip-hooray!
Hop along, developers, come take a look,
A polished README, like a well-loved book! 📚✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)

libs/flowbite-angular/README.md (2)

Line range hint 1-2: Review component status indicators

The removal of :construction: emoji from Buttons, Dropdown, Modal, Navbar, Accordion, and Sidebar components suggests they are now stable. However, the main header still shows :construction: flowbite-angular (unreleased) :construction:. Consider:

Updating the main header if the library is now released

Adding a legend explaining what the :construction: emoji indicates

Adding version information for stable components

Also applies to: 103-103, 125-125, 148-148, 169-169, 236-237

Line range hint 284-286: Clarify documentation for unimplemented components

Several form components (Input Field, File Input, Search Input, etc.) link to the main Flowbite documentation (flowbite.com) instead of Angular-specific documentation. Consider:

Adding a note explaining that these components are not yet implemented in Angular

Creating placeholder pages on flowbite-angular.com with implementation status and roadmap

Or removing these components from the table until they are implemented

Also applies to: 295-297, 306-308

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 31f8d30 and f517728.

📒 Files selected for processing (1)

libs/flowbite-angular/README.md (7 hunks)

libs/flowbite-angular/README.md

MGREMY · 2024-11-15T08:19:58Z

@mruknowme Be careful as normally all commits must be signed :)

And thanks for your contribution ! :D

MGREMY · 2024-12-11T10:03:04Z

🎉 This PR is included in version 1.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

chore: update component links to docs

f517728

vercel bot temporarily deployed to Preview November 15, 2024 00:56 Inactive

coderabbitai bot reviewed Nov 15, 2024

View reviewed changes

libs/flowbite-angular/README.md Show resolved Hide resolved

MGREMY approved these changes Nov 15, 2024

View reviewed changes

MGREMY merged commit d52d67f into themesberg:main Nov 15, 2024

MGREMY linked an issue Nov 15, 2024 that may be closed by this pull request

Update README links to docs #78

Closed

mruknowme deleted the update-readme-component-doc-links branch November 15, 2024 08:28

This was referenced Dec 10, 2024

feat/fix(dropdown): use tailwind classes instead of @floating-ui/dom #77 #83 #86

Merged

1.1.0 #88

Merged

MGREMY added the released label Dec 11, 2024

This was referenced Dec 16, 2024

feat(scroll-top): add support for icon customisation #96

Merged

docs(versioning): add versioning page #98

Merged

feat(badge): add bordered badge #100

Merged

feat(pagination): add new pagination component #106

Merged

coderabbitai bot mentioned this pull request Jan 7, 2025

feat(badge): implement standard configuration #108

Merged

11 tasks

coderabbitai bot mentioned this pull request Jan 22, 2025

feat: make flowbite-navbar-* usable as directive #110

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: update component links to docs #79

chore: update component links to docs #79

Uh oh!

mruknowme commented Nov 15, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Nov 15, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Nov 15, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

MGREMY commented Nov 15, 2024 •

edited

Loading

Uh oh!

MGREMY commented Dec 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chore: update component links to docs #79

chore: update component links to docs #79

Uh oh!

Conversation

mruknowme commented Nov 15, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

PR Type

Issue Number

Does this PR introduce a breaking change?

Other information

Summary by CodeRabbit

Uh oh!

vercel bot commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MGREMY commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MGREMY commented Dec 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mruknowme commented Nov 15, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Nov 15, 2024 •

edited

Loading

coderabbitai bot commented Nov 15, 2024 •

edited

Loading

MGREMY commented Nov 15, 2024 •

edited

Loading