Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: new docs #2740

Merged
merged 70 commits into from Feb 15, 2024
Merged

feat: new docs #2740

merged 70 commits into from Feb 15, 2024

Conversation

MuhammadM1998
Copy link
Contributor

@MuhammadM1998 MuhammadM1998 commented Jan 28, 2024 •
edited

🔗 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 Nuxt Studio
Copy link

nuxt-studio bot commented Jan 28, 2024

✅ Live Preview ready!

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

MuhammadM1998 and others added 27 commits January 28, 2024 16:10
@MuhammadM1998
chore: Nuxt UI Pro + Nuxt Content starter
3e9d87e
@MuhammadM1998
chore: refresh lockfile
820b55e
@MuhammadM1998
chore: update app metadata
f0abae2
@MuhammadM1998
chore: update header title
846ef5a
@MuhammadM1998
refactor: update index page
c8fad3a
@MuhammadM1998
feat: the logo
700dcd2
@MuhammadM1998
feat: navigation links
1d4fc2e
@MuhammadM1998
docs: installation page
2828196
@MuhammadM1998
docs: add getting started icon
3f09774
@MuhammadM1998
docs: update installation page
e390f88
@MuhammadM1998
docs: usage page
de98fcf
@MuhammadM1998
docs: add /guide content
6931d42
@MuhammadM1998
style: add '.env' file icons
8d8f749
@MuhammadM1998
chore: spacing
3e27f8f
@MuhammadM1998
chore: change 'alert' to 'callout'
5222f27
@MuhammadM1998
fix: pin '@nuxt/content' to 2.8.2
c2e4019
@MuhammadM1998
docs: options page
c7213f2
@MuhammadM1998
docs: api
8dc21d6
@MuhammadM1998
docs: roadmap page
2d188b9
@MuhammadM1998
chore: add ts-expect-error
4145a06
@MuhammadM1998
docs: v7
50a32c0
@MuhammadM1998
chore: remove duplicate title
9515798
@MuhammadM1998
refactor: separate v8 & v7 docs pages
dac5052
@MuhammadM1998
style: disallow opening multiple accordions
aa7e816
@MuhammadM1998
Merge branch 'main' of github.com:nuxt-modules/i18n
07c5a5e
@MuhammadM1998
chore: refresh lockfile
9c81b21
@Atinux
chore: add oss license
5ca2966
@MuhammadM1998
Copy link
Contributor Author

@kazupon Can you try running pnpm install first in the workspace root? I've encountered the same error sometimes. Installing the deps for all workspace (pnpm install) solved the issue and the pnpm run docs:dev ran correctly. I'll also check if I could see the root cause

@BobbieGoede
Copy link
Collaborator

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
Copy link
Contributor Author

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

@MuhammadM1998
Copy link
Contributor Author

MuhammadM1998 commented Feb 6, 2024 •
edited

@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
Copy link
Collaborator

kazupon commented Feb 8, 2024

@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 Volta.net
Copy link
Contributor

Atinux commented Feb 10, 2024

Shall be good now!

@BobbieGoede
Copy link
Collaborator

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

@MuhammadM1998
Copy link
Contributor Author

@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
Copy link
Collaborator

kazupon commented Feb 14, 2024

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 Volta.net
Copy link
Contributor

Atinux commented Feb 15, 2024

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

@kazupon
Copy link
Collaborator

kazupon commented Feb 15, 2024

Okay! Thanks!
I'll merge this PR!

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

kazupon commented Feb 15, 2024

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

DarthGigi pushed a commit to DarthGigi/i18n that referenced this pull request Apr 16, 2024
@MuhammadM1998 @Atinux
feat: new docs (nuxt-modules#2740)
d264347 
* 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 <seb@nuxtlabs.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kazupon kazupon Awaiting requested review from kazupon

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs] Revamp the docs
4 participants
@MuhammadM1998 @Atinux @kazupon @BobbieGoede