themesberg / themesberg/flowbite

Improve Astro documentation

Open
#544 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
9.4k
Forks
862
PR merge metrics
No merged PRs in 30d

Description

Currently the documentation for Astro tells you that you have to include a script form: <script is:inline src="https://cdnjs.cloudflare.com/ajax/libs/flowbite/1.6.5/flowbite.min.js"></script>

But it is enough to have

<script>
    import "flowbite";
</script>

I think this should be updated since the import method is way easier.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the Astro documentation section that currently shows the Flowbite CDN script example and compare it with the import example described here. Update the documented integration guidance to reflect the simpler method, then verify that the resulting example is accurate and readable.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, javascript
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.