From b6bdbe3f9cdbb917d455a40db299ffae9533b0a3 Mon Sep 17 00:00:00 2001 From: Inesh Bose Date: Sun, 28 Apr 2024 15:07:27 +0100 Subject: [PATCH] docs: update examples, closes #841 --- .github/ISSUE_TEMPLATE/bug-report.md | 26 ------------- .github/ISSUE_TEMPLATE/bug-report.yml | 38 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 18 +++++++-- .github/ISSUE_TEMPLATE/feature-request.md | 20 ---------- .github/ISSUE_TEMPLATE/feature-request.yml | 20 ++++++++++ .github/ISSUE_TEMPLATE/question.md | 10 ++--- docs/components/TailwindText.vue | 2 +- docs/content/3.examples/1.basic.md | 6 +-- docs/content/3.examples/2.dark-mode.md | 21 ++-------- docs/content/3.examples/3.content.md | 18 +++++++++ docs/content/3.examples/3.nuxt-ui.md | 9 ----- docs/content/3.examples/4.postcss-plugin.md | 12 ------ docs/content/3.examples/4.tailwind-plugins.md | 8 ++++ docs/content/3.examples/5.daisyui.md | 11 ------ docs/content/3.examples/5.postcss-config.md | 13 +++++++ docs/content/3.examples/6.daisyui.md | 9 +++++ docs/content/3.examples/6.flowbite.md | 8 ---- docs/content/3.examples/7.flowbite.md | 8 ++++ docs/content/3.examples/7.tailwind-icons.md | 8 ---- docs/content/3.examples/8.content.md | 16 -------- docs/content/3.examples/8.nuxt-ui.md | 9 +++++ 21 files changed, 149 insertions(+), 141 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 docs/content/3.examples/3.content.md delete mode 100644 docs/content/3.examples/3.nuxt-ui.md delete mode 100644 docs/content/3.examples/4.postcss-plugin.md create mode 100644 docs/content/3.examples/4.tailwind-plugins.md delete mode 100644 docs/content/3.examples/5.daisyui.md create mode 100644 docs/content/3.examples/5.postcss-config.md create mode 100644 docs/content/3.examples/6.daisyui.md delete mode 100644 docs/content/3.examples/6.flowbite.md create mode 100644 docs/content/3.examples/7.flowbite.md delete mode 100644 docs/content/3.examples/7.tailwind-icons.md delete mode 100644 docs/content/3.examples/8.content.md create mode 100644 docs/content/3.examples/8.nuxt-ui.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 22ac29e2..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug report -about: Report a bug report to help us improve the module. -title: '' -labels: 'bug' -assignees: '' - ---- - - - -### Version -@nuxtjs/tailwindcss: -nuxt: - -### Reproduction Link - - -### Steps to reproduce - - -### What is Expected? - - -### What is actually happening? diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..08a3db95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,38 @@ +name: "\U0001F41E Bug report" +description: Report a bug report to help us improve the module +labels: ["bug"] +body: + - type: textarea + id: bug-env + attributes: + label: Environment + description: Use `npx nuxi info` to fill this section. + placeholder: Environment + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: A link to a repo that can reproduce the problem you ran into, or over a web container like Stackblitz using [our template](https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/basic-usage). + placeholder: Reproduction + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: Bug description + validations: + required: true + - type: textarea + id: additonal + attributes: + label: Additional context + description: If applicable, add any other context about the problem here. + - type: textarea + id: logs + attributes: + label: Logs + description: | + Optional if provided reproduction. Please try not to insert an image but copy paste the log text. + render: shell-script diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 1224ebc2..f7386da7 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,17 @@ blank_issues_enabled: false contact_links: - - name: Nuxt Community Discord - url: https://discord.nuxtjs.org/ - about: Consider asking questions about the module here. + - name: 📚 Nuxt Documentation + url: https://nuxt.com/docs + about: Check the documentation for usage of Nuxt + - name: 💬 Nuxt Discussions + url: https://github.com/nuxt/nuxt/discussions + about: Check if there is anything related to your issue on Nuxt discussions + - name: 📚 Tailwind CSS Documentation + url: https://tailwindcss.com/docs + about: Check the documentation for usage of Tailwind CSS + - name: 💬 Tailwind CSS GitHub + url: https://github.com/tailwindlabs/tailwindcss + about: Check if there is anything related to your issue on the Tailwind CSS repository + - name: 👥 Nuxt Discord Server + url: https://chat.nuxt.dev/ + about: Consider asking questions about the module here diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index f6a5b872..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea or enhancement for the module. -title: '' -labels: 'enhancement' -assignees: '' - ---- - -### Is your feature request related to a problem? Please describe. - - -### Describe the solution you'd like - - -### Describe alternatives you've considered - - -### Additional context - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..7664fcda --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,20 @@ +name: "🚀 Feature request" +description: Suggest an idea or enhancement for the module +labels: ["enhancement"] +body: + - type: textarea + id: feature-description + attributes: + label: Describe the feature + description: A clear and concise description of what you think would be a helpful addition to the module, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. + placeholder: Feature description + validations: + required: true + - type: checkboxes + id: additional-info + attributes: + label: Additional information + description: Additional information that helps us decide how to proceed. + options: + - label: Would you be willing to help implement this feature? + - label: Could this feature be implemented as a module? diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 6cd9b136..5bf88371 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,6 +1,6 @@ --- -name: Question -about: Ask a question about the module. +name: ❓ Question +about: Ask a question about the module title: '' labels: 'question' assignees: '' @@ -8,9 +8,7 @@ assignees: '' --- diff --git a/docs/components/TailwindText.vue b/docs/components/TailwindText.vue index ec338a60..fbc4c168 100644 --- a/docs/components/TailwindText.vue +++ b/docs/components/TailwindText.vue @@ -1,7 +1,7 @@