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.

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

docs: add docs page #146

Merged
merged 17 commits into from
May 22, 2024
Merged

docs: add docs page #146

merged 17 commits into from
May 22, 2024

Conversation

qwerzl
Copy link
Member

@qwerzl qwerzl commented May 1, 2024

This PR adds a docs page, some parts come from Nuxt Image.

@codecov-commenter
Copy link

codecov-commenter commented May 3, 2024

Codecov Report

Attention: Patch coverage is 0% with 1242 lines in your changes are missing coverage. Please review.

Project coverage is 45.24%. Comparing base (bf586c4) to head (4b7abfa).

Files Patch % Lines
docs/components/TheIllustration.vue 0.00% 247 Missing and 1 partial ⚠️
docs/nuxt.schema.ts 0.00% 217 Missing and 1 partial ⚠️
docs/pages/index.vue 0.00% 173 Missing and 1 partial ⚠️
docs/app.vue 0.00% 137 Missing and 1 partial ⚠️
docs/pages/[...slug].vue 0.00% 112 Missing and 1 partial ⚠️
docs/app.config.ts 0.00% 55 Missing and 1 partial ⚠️
docs/error.vue 0.00% 54 Missing and 1 partial ⚠️
docs/components/AppHeader.vue 0.00% 52 Missing and 1 partial ⚠️
docs/components/AdsCarbon.vue 0.00% 47 Missing and 1 partial ⚠️
docs/nuxt.config.ts 0.00% 35 Missing and 1 partial ⚠️
... and 5 more
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #146        /-   ##
===========================================
- Coverage   65.89%   45.24%   -20.66%     
===========================================
  Files          41       56        15     
  Lines        2721     3963      1242     
  Branches      413      428        15     
===========================================
  Hits         1793     1793               
- Misses        903     2130      1227     
- Partials       25       40        15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@danielroe danielroe closed this May 20, 2024
@danielroe danielroe reopened this May 20, 2024
@danielroe
Copy link
Member

(closed/reopened to try to trigger cloudflare to deploy it as preview)

@danielroe
Copy link
Member

I've tried to go through the docs and add any missing pieces. I see you have plans for more advanced provider docs - which would be amazing!

I also think we need to improve the OG image previews, mostly by having a logo. @atinux could you help with a logo, perhaps? 🙏

However, I think we probably could go ahead and merge as is so we can keep in sync with updates to the docs/features. What do you think @qwerzl?

@qwerzl
Copy link
Member Author

qwerzl commented May 20, 2024

I've tried to go through the docs and add any missing pieces. I see you have plans for more advanced provider docs - which would be amazing!

I also think we need to improve the OG image previews, mostly by having a logo. @atinux could you help with a logo, perhaps? 🙏

However, I think we probably could go ahead and merge as is so we can keep in sync with updates to the docs/features. What do you think @qwerzl?

@danielroe That would be great! I'm setting this PR to be ready for review.

@qwerzl qwerzl marked this pull request as ready for review May 20, 2024 23:38
@qwerzl qwerzl requested a review from danielroe as a code owner May 20, 2024 23:38
@dosubot dosubot bot added size:XXL This PR changes 1000 lines, ignoring generated files. documentation Improvements or additions to documentation labels May 20, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 22, 2024
@danielroe danielroe merged commit 57f8301 into nuxt:main May 22, 2024
1 check passed
@github-actions github-actions bot mentioned this pull request May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants