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: Improved docs and links #970

Merged
merged 14 commits into from
Sep 22, 2024
Merged

Conversation

okineadev
Copy link
Contributor

@okineadev okineadev commented Sep 5, 2024

I've made a few improvements, here's a list of them:

Copy link

netlify bot commented Sep 5, 2024

Deploy Preview for creative-fairy-df92c4 ready!

Name Link
🔨 Latest commit 1e7d0de
🔍 Latest deploy log https://app.netlify.com/sites/creative-fairy-df92c4/deploys/66f01e215dc2f80008f5ac21
😎 Deploy Preview https://deploy-preview-970--creative-fairy-df92c4.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 configuration.

Copy link
Collaborator

@aklinker1 aklinker1 left a comment

Choose a reason for hiding this comment

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

Thanks for the changes!

Symlinked readme from README.md to packages/wxt/README.md (idk if it works properly)

Oh that's smart, I'll pull this down later and double check it!

@okineadev
Copy link
Contributor Author

Symbolic links do not work 100%

@okineadev
Copy link
Contributor Author

This should be fixed

@okineadev okineadev requested a review from aklinker1 September 6, 2024 11:13
@aklinker1 aklinker1 changed the title Improved documentation and links docs: Improved docs and links Sep 6, 2024
Copy link
Collaborator

@aklinker1 aklinker1 left a comment

Choose a reason for hiding this comment

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

Didn't revert the URL in the
README: #970 (comment)

@aklinker1
Copy link
Collaborator

aklinker1 commented Sep 6, 2024

Note to self: double check the symlinked README gets packed in the NPM tarball correctly

@okineadev
Copy link
Contributor Author

Didn't revert the URL in the README: #970 (comment)

?

aklinker1

This comment was marked as outdated.

@okineadev okineadev requested a review from aklinker1 September 7, 2024 00:33
@okineadev
Copy link
Contributor Author

@aklinker1

Copy link
Collaborator

@aklinker1 aklinker1 left a comment

Choose a reason for hiding this comment

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

Published a test version to see what it looks like on NPM, and there's no README. Looks like pnpm pack ignores the symlinked README. So that solution won't work.

image

https://www.npmjs.com/package/wxt/v/0.19.10-alpha1

Should we use automd for syncing the READMEs instead?

README.md Outdated
<a href="https://wxt.dev/api/config.html" target="_blank">Configuration</a>
<a href="https://wxt.dev/api/config" target="_blank">Configuration</a>
Copy link
Collaborator

@aklinker1 aklinker1 Sep 10, 2024

Choose a reason for hiding this comment

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

I don't think removing all HTML suffixes is meaningful. It breaks my redirects I have setup for old links too... I don't want to have two entries for each redirect, one with .html and one without.

https://github.com/wxt-dev/wxt/blob/main/docs/public/_redirects

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Look, in my opinion there should be a single standard - no suffix, because shorter links look better, about those links with a suffix - maybe it's good, but I don't see any point in it...

Copy link
Contributor Author

@okineadev okineadev Sep 11, 2024

Choose a reason for hiding this comment

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

I mean that if you went to a page with a suffix, you will go to a page with a suffix, if without a suffix, then with suffix

I just want a single link type without a suffix to be used in the future

Copy link
Collaborator

Choose a reason for hiding this comment

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

I agree, I'd prefer no suffix, but the current netlify and vitepress setup defaults to .html for everything. So that's what we should continue to use for now 🤷

@okineadev
Copy link
Contributor Author

Published a test version to see what it looks like on NPM, and there's no README. Looks like pnpm pack ignores the symlinked README. So that solution won't work.

image

https://www.npmjs.com/package/wxt/v/0.19.10-alpha1

Should we use automd for syncing the READMEs instead?

Later I will try to create a physical link (idk how it works, but it will probably be a more reliable link)

@okineadev okineadev requested a review from aklinker1 September 14, 2024 07:22
Copy link

pkg-pr-new bot commented Sep 22, 2024

Open in Stackblitz

@wxt-dev/auto-icons

pnpm add https://pkg.pr.new/@wxt-dev/auto-icons@970

@wxt-dev/i18n

pnpm add https://pkg.pr.new/@wxt-dev/i18n@970

@wxt-dev/module-react

pnpm add https://pkg.pr.new/@wxt-dev/module-react@970

@wxt-dev/module-solid

pnpm add https://pkg.pr.new/@wxt-dev/module-solid@970

@wxt-dev/module-svelte

pnpm add https://pkg.pr.new/@wxt-dev/module-svelte@970

@wxt-dev/module-vue

pnpm add https://pkg.pr.new/@wxt-dev/module-vue@970

wxt

pnpm add https://pkg.pr.new/wxt@970

commit: 1e7d0de

Copy link

codecov bot commented Sep 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.81%. Comparing base (fbe502f) to head (f708974).
Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #970      +/-   ##
==========================================
- Coverage   82.25%   81.81%   -0.44%     
==========================================
  Files         125      125              
  Lines        6604     6604              
  Branches     1104     1097       -7     
==========================================
- Hits         5432     5403      -29     
- Misses       1158     1187      +29     
  Partials       14       14              

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

@aklinker1 aklinker1 merged commit a82c7cb into wxt-dev:main Sep 22, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants