flowbite-angular icon indicating copy to clipboard operation
flowbite-angular copied to clipboard
verified publisher icon themesberg

Rework documentation front

Open MGREMY opened this issue 1 year ago • 2 comments

Changes :

Component pages

  • [x] Accordion
  • [x] Alert
  • [x] Badge
  • [x] Breadcrumb
  • [x] Button
  • [x] Dropdown
  • [x] Indicator
  • [x] Modal
  • [ ] Navbar
  • [ ] Scroll-top
  • [ ] Sidebar
  • [ ] Forms

Each pages

  • [ ] List on right side with important part of the page (ex. Alert → Default alert | Alert with icon)

Customize pages

  • [x] Override component base style → Add a page to explain how to override component's base style used in theme services
  • [x] CustomStyle → Add a page to explain how to add CustomStyle OR add a section per component pages with dedicated example
  • [ ] Inheriting component → Add a page to explain how to create component with inheritance

Fixes and features

  • [x] Change input type boolean from boolean string | boolean to boolean, unknown as the input of booleanAttribute is unknown
  • [x] Move default value in child component to be the one in parent component (ex. SidebarItemComponent.color = (SidebarItemGroupComponent||SidebarMenuComponent).color
  • [ ] Update SidebarItemComponent's color to get SidebarItemGroup or SidebarMenuComponent's color
  • [ ] Move shared features to structural directive if possible
  • [x] Sidebar display over with backdrop
  • [ ] Modal backdrop, see #33

MGREMY avatar Jul 04 '24 17:07 MGREMY

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 Oct 24, 2024 0:30am

vercel[bot] avatar Jul 04 '24 17:07 vercel[bot]

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

87 files out of 172 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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[bot] avatar Jul 04 '24 17:07 coderabbitai[bot]

The remaining items of this PR will be treated on another branch after some project setup adjustment. The next branch will be focused on versioning setup, project setup (and switch (yes again) from npm to pnpm), version switch (will be setup to use latest 18.0.0 LTS angular version), and other project/repo stuff.

MGREMY avatar Oct 24 '24 12:10 MGREMY

:tada: This PR is included in version 1.0.0-beta.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

MGREMY avatar Nov 04 '24 14:11 MGREMY

:tada: This PR is included in version 1.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

MGREMY avatar Nov 11 '24 17:11 MGREMY