Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.

docs: use nuxt 3 and website theme - #5479

Merged
atinux merged 75 commits into
mainfrom
feat/docus-docs
Oct 6, 2022
Merged

docs: use nuxt 3 and website theme#5479
atinux merged 75 commits into
mainfrom
feat/docus-docs

Conversation

@Tahul

@Tahul Tahul commented Jun 15, 2022

Copy link
Copy Markdown
Contributor

❓ Type of change

  • 👌 Enhancement (improving an existing functionality like performance)

📚 Description

Upgrade docs/ directory to use latest nuxtlabs/docus version.

This implies that the docs now runs on Nuxt 3.

TODO:

📝 Checklist

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

resolves nuxt/nuxt#13571

@netlify

netlify Bot commented Jun 15, 2022

Copy link
Copy Markdown

Deploy Preview for nuxt3-docs ready!

Name Link
🔨 Latest commit 518a4b3
🔍 Latest deploy log https://app.netlify.com/sites/nuxt3-docs/deploys/633d768e721d9c000848b53b
😎 Deploy Preview https://deploy-preview-5479--nuxt3-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@pi0

pi0 commented Jun 15, 2022

Copy link
Copy Markdown
Member

This is amazing! Thank you so much for working on this.

Same as previous PR, I think we shall move new docs to the theme so that can maintain it easier and also reuse for the translations repo. I think this way we can finally move forward from legacy nuxt 2 docs.

@Tahul

Tahul commented Jun 15, 2022

Copy link
Copy Markdown
Contributor Author

I would love to get some help to get the deployment to work 😄

@Tahul

Tahul commented Jun 16, 2022

Copy link
Copy Markdown
Contributor Author

@pi0 ; I updated the PR following your guidelines!

nuxt/nuxt3-docs now holds the theme for nuxt/framework/docs. 🙂

It is used via @docus/nuxt3-docs package but can be republished under the naming that fits you!

Will continue the work on Docus tomorrow closing the TODOs from here!

I would love to get this branch deployed, it should be doable using nuxi generate!

@Tahul
Tahul force-pushed the feat/docus-docs branch from 0ed58ef to fa8c277 Compare June 17, 2022 13:03
@Tahul

Tahul commented Jun 17, 2022

Copy link
Copy Markdown
Contributor Author

@pi0 @danielroe ; this one is ready to be merged for me! (if that latest deployment passes 😄)

@atinux @alexchopin might want to make a last review!

@danielroe
danielroe self-requested a review June 17, 2022 18:00

@danielroe danielroe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! ❤️

Comment thread docs/content/2.guide/1.concepts/index.md Outdated
@atinux

atinux commented Jun 19, 2022

Copy link
Copy Markdown
Member

recording

We need to fix these layout shifts issues on the icons top right and I feel something weird when changing layouts.

Browser metadata
Path:      /
Browser:   Chrome 102.0.5005.115 on Mac OS 10.15.7
Viewport:  1728 x 1000 @2x
Language:  en-GB
Cookies:   Enabled

Open in BrowserStack

Open Deploy Preview · Mark as Resolved

@danielroe

danielroe commented Jun 20, 2022

Copy link
Copy Markdown
Member

I think the icon layout shift is due to how color mode icon is implemented - it flickers to three dots and back:

CleanShot 2022-06-20 at 09 36 42

@atinux

atinux commented Jun 20, 2022

Copy link
Copy Markdown
Member

It should not flicker on client-side 🤔

@Tahul

Tahul commented Jun 20, 2022

Copy link
Copy Markdown
Contributor Author

It should not flicker on client-side 🤔

nuxt-content/docus@7ecc8e8

This is fixed in that commit.

@pi0 pi0 changed the title feat(docs): upgrade docs to latest Docus docs: use nuxt 3 and docus based theme Jul 7, 2022
@vercel
vercel Bot temporarily deployed to Preview October 3, 2022 10:31 Inactive
@vercel
vercel Bot temporarily deployed to Preview October 3, 2022 13:11 Inactive
@vercel
vercel Bot temporarily deployed to Preview October 4, 2022 10:41 Inactive
@vercel
vercel Bot temporarily deployed to Preview October 4, 2022 13:39 Inactive
@atinux
atinux marked this pull request as ready for review October 4, 2022 17:04
@atinux

atinux commented Oct 4, 2022

Copy link
Copy Markdown
Member

Once merged, we will need to update the deployments to point v3.nuxtjs.org to Vercel one.

@atinux

atinux commented Oct 4, 2022

Copy link
Copy Markdown
Member

Website can be tested on https://v3-wip.nuxtjs.org/

@vercel
vercel Bot temporarily deployed to Preview October 4, 2022 17:09 Inactive
@vercel
vercel Bot temporarily deployed to Preview October 5, 2022 12:24 Inactive
@atinux
atinux merged commit dc47c64 into main Oct 6, 2022
@atinux
atinux deleted the feat/docus-docs branch October 6, 2022 09:15
@danielroe danielroe mentioned this pull request Oct 9, 2022
@danielroe danielroe added the 3.x label Jan 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

3.x documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Install Docs depencies on Windows fails

5 participants