Docs/guides/adonis js

[SutuSebastian]

Changes

• add AdonisJS integration guides in web docs
• update cli to support it
• cleanup web docs sidebar NEW stale badges

Summary by CodeRabbit

• New Features

  • Introduced an integration guide for using Flowbite React with AdonisJS.
  • Added support for dark mode configuration with AdonisJS.
  • Included new CLI commands and project setup instructions for AdonisJS integration.

• Documentation

  • Updated the sidebar to remove the "new" label from several items.
  • Added AdonisJS guide link to the installation instructions in the README.

• Chores

  • Added AdonisJS entry to the REPOS constant for CLI use.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 21, 2024 1:52pm
flowbite-react-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 21, 2024 1:52pm

[changeset-bot]

🦋 Changeset detected

Latest commit: 955d2da

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
create-flowbite-react	Patch
flowbite-react	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Walkthrough

The recent update introduces an AdonisJS integration guide for flowbite-react, enhancing the developer experience with detailed setup instructions, CLI commands, Tailwind CSS configuration, and dark mode support. It also includes updates to various documentation and code files to reflect this integration, such as the integration-guides.tsx component and docs-sidebar.ts, along with an additional entry in the CLI package's repositories.

Changes

File(s)	Change Summary
.changeset/purple-rocks-divide.md	Introduced an AdonisJS integration guide for flowbite-react.
apps/web/components/quickstart/integration-guides.tsx	Added AdonisJS integration guide with its logo and custom class.
apps/web/content/docs/guides/adonis-js.mdx	Provided detailed guidance on using Flowbite React with AdonisJS, including CLI and setup examples.
apps/web/data/docs-sidebar.ts	Removed isNew: true property from several items in the DOCS_SIDEBAR constant array.
packages/cli/src/data.ts	Added AdonisJS repository to the REPOS constant array.
packages/ui/README.md	Added a link to the AdonisJS guide in the installation instructions section.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant CLI as CLI Tool
    participant Guide as AdonisJS Guide
    participant WebApp as Web Application
    
    Dev->>CLI: Request AdonisJS Project Template
    CLI-->>Dev: Provide AdonisJS Template URL
    Dev->>Guide: Follow Integration Guide
    Guide-->>Dev: Setup Instructions
    Dev->>WebApp: Apply Configuration
    WebApp-->>Dev: Successful Setup with Flowbite React

Loading

Poem

In the land of Flowbite's stream,
AdonisJS joins the team,
With guides so clear and bright,
Developers see the light.
From setup to dark mode's gleam,
Flowbite's now Adonis' dream.
Cheers to code both day and night! 🌙✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ba3463d and 955d2da.

Files ignored due to path filters (1)

• apps/web/public/logos/adonis-js.svg is excluded by !**/*.svg

Files selected for processing (6)

• .changeset/purple-rocks-divide.md (1 hunks)
• apps/web/components/quickstart/integration-guides.tsx (1 hunks)
• apps/web/content/docs/guides/adonis-js.mdx (1 hunks)
• apps/web/data/docs-sidebar.ts (4 hunks)
• packages/cli/src/data.ts (1 hunks)
• packages/ui/README.md (1 hunks)

Files skipped from review due to trivial changes (3)

• .changeset/purple-rocks-divide.md
• apps/web/data/docs-sidebar.ts
• packages/cli/src/data.ts

Additional context used

LanguageTool

packages/ui/README.md

[uncategorized] ~41-~41: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ... --- ### flowbite-react is an open source collection of UI components, built in R...

---

[style] ~49-~49: Consider using an alternative to strengthen your wording. (WANT_KEEN)
Context: ...](https://flowbite-react.com/). If you want to learn more about Flowbite, visit [Fl...

---

[uncategorized] ~75-~75: Possible missing preposition found. (AI_EN_LECTOR_MISSING_PREPOSITION)
Context: ...e-react@latest ``` The CLI will prompt the directory name, what template to use an...

---

[grammar] ~315-~315: Did you mean simply “discuss the”? You do not need the word “about” here. (MENTION_ABOUT)
Context: ...unity If you need help or just want to discuss about the library join the community on Github: ...

---

[uncategorized] ~315-~315: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ... help or just want to discuss about the library join the community on Github: ⌨️ [Disc...

---

[grammar] ~317-~317: Did you mean simply “Discuss Flowbite”? You do not need the word “about” here. (MENTION_ABOUT)
Context: ...rary join the community on Github: ⌨️ [Discuss about Flowbite on GitHub](https://github.com/themesber...

---

[uncategorized] ~329-~329: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...ma If you need the Figma files for the components you can check out our website for more ...

Markdownlint

packages/ui/README.md

41-41: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading

---

13-13: null (MD045, no-alt-text)
Images should have alternate text (alt text)

Additional comments not posted (3)

apps/web/components/quickstart/integration-guides.tsx (1)

19-19: AdonisJS Guide Addition Approved

The addition of the AdonisJS guide to the GUIDES array is consistent with the existing structure and properties of other guides. This ensures uniformity and correct integration within the UI.

apps/web/content/docs/guides/adonis-js.mdx (1)

1-149: Comprehensive AdonisJS Guide Approved

The new guide for integrating AdonisJS with Flowbite React is well-structured, clear, and comprehensive. It covers all necessary steps from CLI commands to dark mode configuration, providing valuable information to users.

packages/ui/README.md (1)

87-87: AdonisJS Guide Link Addition Approved

The addition of the AdonisJS guide link in the README is correctly formatted and follows the existing pattern of guide links, providing users with direct access to the new guide.