-
-
Notifications
You must be signed in to change notification settings - Fork 256
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
Conversation
✅ Deploy Preview for creative-fairy-df92c4 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this 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!
Symbolic links do not work 100% |
This should be fixed |
There was a problem hiding this 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)
Note to self: double check the symlinked README gets packed in the NPM tarball correctly |
? |
There was a problem hiding this 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.
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> |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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...
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 🤷
Later I will try to create a physical link (idk how it works, but it will probably be a more reliable link) |
@wxt-dev/auto-icons
@wxt-dev/i18n
@wxt-dev/module-react
@wxt-dev/module-solid
@wxt-dev/module-svelte
@wxt-dev/module-vue
wxt
commit: |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
I've made a few improvements, here's a list of them:
README.md
(46ee018)alt
attributes (725cf1a)README.md
topackages/wxt/README.md
(6318582)