feat: new docs #2740

MuhammadM1998 · 2024-01-28T13:29:25Z

🔗 Linked issue

Resolves #2692

❓ Type of change

📖 Documentation (updates to the documentation or readme)
🐞 Bug fix (a non-breaking change that fixes an issue)
👌 Enhancement (improving an existing functionality like performance)
✨ New feature (a non-breaking change that adds functionality)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This updates the docs to use Nuxt UI Pro & Nuxt Content. Moving away from the un-maintained Docus and aligning with the other official modules docs.

I've tried to keep minimal changes and not changing the content for easier migration. I'll open other PRs to improve the docs sections I'm confident about later.

Changes

Grouped the docs for v8 (Get started, guide, options, API) in one page inside instead of separate pages and aligning with the official nuxt docs
Added a version switcher to change between versions 8 and 7 docs
Roadmap has its own page with the same volta board iframe but now it matches the app theme

TODOs

Homepage
Migrate content files as is and refactor syntax if needed (e.g using ::callout instead of <alert> or ::alert)
Ensure OG Images are generated for the docs
SEO
Refactor & Cleanup
~~Build locally and check if everything works correctly~~ (Needs license to run nuxt generate)

Builds Are Failing
Builds are failing as it needs NuxtUI Pro license which we don't have yet, a workaround is to set env for this deployment to 'development' so it doesn't ask for the license

📝 Checklist

I have linked an issue or discussion.
I have updated the documentation accordingly.

nuxt-studio · 2024-01-28T13:29:29Z

✅ Live Preview ready!

Name	Edit	Preview	Latest Commit
i18n	Edit on Studio ↗︎	View Live Preview	`13fd55b`

BobbieGoede · 2024-02-06T08:37:53Z

I'm getting the same error, I did run pnpm install in the workspace root.

I found this issue https://github.com/nuxt/ui-pro/issues/37 that seems to describe a similar issue, the error went away after adding the following lines to docs/.npmrc (suggested by https://github.com/nuxt/ui-pro/issues/37#issuecomment-1811381891) and reinstalling.

shamefully-hoist=true
strict-peer-dependencies=false

MuhammadM1998 · 2024-02-06T08:53:02Z

@BobbieGoede Thanks for finding out! I'll add them and recheck if everything works

…pmrc

MuhammadM1998 · 2024-02-06T12:09:33Z

@BobbieGoede @kazupon I've pushed changes and tested locally by removing node_modules and running this

pnpm install && pnpm run --filter @nuxtjs/i18n-docs dev

It worked correctly. Please check now on your side. I've also bumped nuxt/content and the syntax highlighting issues were fixed so ignore my past comment.

kazupon · 2024-02-08T04:52:02Z

@MuhammadM1998
Thanks!
I've checked new docs!
It's amazing! ❤️ ✨

@atinux
When I've build, I've got the license the below error message:

> nuxi build docs

Nuxt 3.8.2 with Nitro 2.8.1                                                                                                                                              13:48:40
ℹ Using default Tailwind CSS file                                                                                                                      nuxt:tailwindcss 13:48:41

 ERROR  Invalid NUXT_UI_PRO_LICENSE license key.                                                                                                                         13:48:43
Purchase Nuxt UI Pro at https://ui.nuxt.com/pro/purchase to build your app in production.

 ELIFECYCLE  Command failed with exit code 1.
 
 ```
 
 We can deploy nuxt i18n new docs, when we will config `NUXT_UI_PRO_LICENSE` in the netlify environment variable, correct?

atinux · 2024-02-10T16:21:31Z

Shall be good now!

…github.com:nuxt-modules/i18n

BobbieGoede · 2024-02-14T15:37:01Z

This looks good but I don't know what steps are left to make deployment work 🤔

MuhammadM1998 · 2024-02-14T16:16:41Z

@BobbieGoede Preview Deployment is already working https://deploy-preview-2740--nuxt-i18n.netlify.app/
Production deployment works the same as Preview so I think there should be no further problems. Just making sure that NuxtUI Pro keys are added to env variables for Production too not just Preview on Netlify.

I'm available If there's anything I could help with

kazupon · 2024-02-14T23:48:27Z

I've checked netlify enviroment variables.
I've found out NUXT_UI_PRO_LICENSE at ntlify.

@atinux
Do we need the configure license in netlify?

atinux · 2024-02-15T00:24:45Z

No need for a NUXT_UI_PRO_LICENSE when it's an open source repo on nuxt-modules org :)

kazupon · 2024-02-15T01:16:39Z

Okay! Thanks!
I'll merge this PR!

kazupon · 2024-02-15T01:17:49Z

@MuhammadM1998
Thank you very much again!
we really appreciate your contribution! 💚

* feat: new docs * chore: ignore docs from linting * chore: Nuxt UI Pro + Nuxt Content starter * chore: refresh lockfile * chore: update app metadata * chore: update header title * refactor: update index page * feat: the logo * feat: navigation links * docs: installation page * docs: add getting started icon * docs: update installation page * docs: usage page * docs: add /guide content * style: add '.env' file icons * chore: spacing * chore: change 'alert' to 'callout' * fix: pin '@nuxt/content' to 2.8.2 * docs: options page * docs: api * docs: roadmap page * chore: add ts-expect-error * docs: v7 * chore: remove duplicate title * refactor: separate v8 & v7 docs pages * style: disallow opening multiple accordions * chore: refresh lockfile * chore: add oss license * feat: implement VersionSelect to switch module versions * refactor: move all docs under '/docs' route * docs: update homepage links * refactor: match page name to its title * feat: add code group in homepage * feat: dynamically show full or truncate i18n ero title * feat: og image * refactor: remove redundant props * chore: cleanup * refactor: cleanup * refactor: remove empty 'logo' object * chore: remove redundant 'viewport' as it's automatically added * refactor: set `titleTemplate` in app.vue * refactor: `usePageMeta` composable * chore: avoid using single-name components * refactor: set header 'links' props to optional * refactor: add 'ts-expect-error' * refactor: remove redundant 'v7' page * chore: rename first pages to index * fix: broken link * chore: update relative links * chore: fix broken links * chore: add `strict-peer-dependencies` to docs npmrc * chore: remove redundant 'vue' resolution * chore: add 'shamefully-hoist' & 'strict-peer-dependencies' to root .npmrc * chore: bump nuxt content and ui pro * chore: organize a bit * chore: remove 'asciidoc name from codeblocks * chore: replace 'env' with 'shell' * fix: 'env' icons are not rendered * chore: refresh lockfile * chore: highlight `jsonc` code blocks --------- Co-authored-by: Sébastien Chopin <[email protected]>

MuhammadM1998 added 2 commits January 28, 2024 15:18

feat: new docs

13fd55b

chore: ignore docs from linting

c1e6d9a

MuhammadM1998 and others added 27 commits January 28, 2024 16:10

chore: Nuxt UI Pro + Nuxt Content starter

3e9d87e

chore: refresh lockfile

820b55e

chore: update app metadata

f0abae2

chore: update header title

846ef5a

refactor: update index page

c8fad3a

feat: the logo

700dcd2

feat: navigation links

1d4fc2e

docs: installation page

2828196

docs: add getting started icon

3f09774

docs: update installation page

e390f88

docs: usage page

de98fcf

docs: add /guide content

6931d42

style: add '.env' file icons

8d8f749

chore: spacing

3e27f8f

chore: change 'alert' to 'callout'

5222f27

fix: pin '@nuxt/content' to 2.8.2

c2e4019

docs: options page

c7213f2

docs: api

8dc21d6

docs: roadmap page

2d188b9

chore: add ts-expect-error

4145a06

docs: v7

50a32c0

chore: remove duplicate title

9515798

refactor: separate v8 & v7 docs pages

dac5052

style: disallow opening multiple accordions

aa7e816

Merge branch 'main' of github.com:nuxt-modules/i18n

07c5a5e

chore: refresh lockfile

9c81b21

chore: add oss license

5ca2966

MuhammadM1998 added 9 commits February 6, 2024 10:53

chore: add strict-peer-dependencies to docs npmrc

8064496

Merge branch 'nuxt-modules:main' into main

039cb75

chore: remove redundant 'vue' resolution

1a0df61

chore: add 'shamefully-hoist' & 'strict-peer-dependencies' to root .n…

d9258ac

…pmrc

chore: bump nuxt content and ui pro

ea38003

chore: organize a bit

7e03522

chore: remove 'asciidoc name from codeblocks

9366f6b

chore: replace 'env' with 'shell'

dc4299a

fix: 'env' icons are not rendered

f0917ad

MuhammadM1998 added 3 commits February 8, 2024 10:17

Merge branch 'main' into main

466d402

chore: refresh lockfile

4760ccd

chore: highlight jsonc code blocks

a042007

MuhammadM1998 added 3 commits February 13, 2024 00:03

Merge branch 'main' of personal:MuhammadM1998/i18n; branch 'main' of …

80e7015

…github.com:nuxt-modules/i18n

Merge branch 'main' of github.com:nuxt-modules/i18n

b94dd22

Merge branch 'nuxt-modules:main' into main

55f3027

Merge branch 'main' of github.com:nuxt-modules/i18n

6bb2aae

kazupon merged commit 71e51fc into nuxt-modules:main Feb 15, 2024
7 checks passed

BobbieGoede mentioned this pull request May 31, 2024

docs: migrate documentation to Nuxt UI vueuse/motion#198

Open

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: new docs #2740

feat: new docs #2740

MuhammadM1998 commented Jan 28, 2024 •

edited

Loading

nuxt-studio bot commented Jan 28, 2024

BobbieGoede commented Feb 6, 2024

MuhammadM1998 commented Feb 6, 2024

MuhammadM1998 commented Feb 6, 2024 •

edited

Loading

kazupon commented Feb 8, 2024

atinux commented Feb 10, 2024

BobbieGoede commented Feb 14, 2024

MuhammadM1998 commented Feb 14, 2024

kazupon commented Feb 14, 2024

atinux commented Feb 15, 2024

kazupon commented Feb 15, 2024

kazupon commented Feb 15, 2024

feat: new docs #2740

feat: new docs #2740

Conversation

MuhammadM1998 commented Jan 28, 2024 • edited Loading

🔗 Linked issue

❓ Type of change

📚 Description

📝 Checklist

nuxt-studio bot commented Jan 28, 2024

✅ Live Preview ready!

BobbieGoede commented Feb 6, 2024

MuhammadM1998 commented Feb 6, 2024

MuhammadM1998 commented Feb 6, 2024 • edited Loading

kazupon commented Feb 8, 2024

atinux commented Feb 10, 2024

BobbieGoede commented Feb 14, 2024

MuhammadM1998 commented Feb 14, 2024

kazupon commented Feb 14, 2024

atinux commented Feb 15, 2024

kazupon commented Feb 15, 2024

kazupon commented Feb 15, 2024

MuhammadM1998 commented Jan 28, 2024 •

edited

Loading

MuhammadM1998 commented Feb 6, 2024 •

edited

Loading