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 more community plugins #953

Merged
merged 2 commits into from
Apr 18, 2024

Conversation

linbudu599
Copy link
Contributor

Summary

Add list of plugins from rspress-plugins.

This _meta.json was updated by alphabetical order.

Related Issue

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copy link

netlify bot commented Apr 14, 2024

Deploy Preview for aquamarine-blini-95325f ready!

Name Link
🔨 Latest commit b77e2e2
🔍 Latest deploy log https://app.netlify.com/sites/aquamarine-blini-95325f/deploys/661ca02f303b5e00085b0a2c
😎 Deploy Preview https://deploy-preview-953--aquamarine-blini-95325f.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 86 (🟢 up 3 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@chenjiahan
Copy link
Member

Thank you for your contribution!

From my perspective, maintaining the documentation of all community plugins in the Rspress documentation site is not appropriate. This results in the community plugin's code and documentation not being maintained in the same place.

I suggest maintaining the documentation and code of the community plugins in the same repository, then add the repository link to Rspress website and awesome-rspack. This allows users to discover and use these community plugins.

@linbudu599
Copy link
Contributor Author

Thank you for your contribution!

From my perspective, maintaining the documentation of all community plugins in the Rspress documentation site is not appropriate. This results in the community plugin's code and documentation not being maintained in the same place.

I suggest maintaining the documentation and code of the community plugins in the same repository, then add the repository link to Rspress website and awesome-rspack. This allows users to discover and use these community plugins.

I actually think so, this synchronization process is indeed cumbersome enough, so I need to update the sidebar configuration to the absolute address to the plugin address?

@chenjiahan
Copy link
Member

You can add the absolute address to this page: https://rspress.dev/plugin/official-plugins/overview.html#community-plugins

The left side bar should only contains official plugins, @Timeless0911 please check this

@linbudu599
Copy link
Contributor Author

I would suggest to move community plugins to a seperate page like community-plugins/overview instead of a sub heading like official-plugins/overview#community-plugins.

The latest commit had made changes described above. cc @chenjiahan @Timeless0911

@linbudu599 linbudu599 force-pushed the docs/add_community_plugin branch from c2464b5 to b77e2e2 Compare April 15, 2024 03:34
@Timeless0911
Copy link
Contributor

LGTM

@Timeless0911
Copy link
Contributor

It seems the doc about translate plugin is linked to rspress website as is shown in https://github.com/byteHulk/rspress-plugin-translate/blob/master/README.md

Do we need to contact the author to move the document to his plugin repo for maintenance? @chenjiahan

@chenjiahan
Copy link
Member

Do we need to contact the author to move the document to his plugin repo for maintenance? @chenjiahan

Sure, @byteHulk can you move the document of rspress-plugin-translate to its own repo? ❤️

Copy link
Member

@chenjiahan chenjiahan left a comment

Choose a reason for hiding this comment

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

This PR will be merged once rspress-plugin-translate documentation has been completed.

@chenjiahan chenjiahan merged commit 19cf589 into web-infra-dev:main Apr 18, 2024
8 checks passed
@chenjiahan
Copy link
Member

I will merge this PR first.

@byteHulk please help to move the document of rspress-plugin-translate to its own repo when you have time ❤️

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.

3 participants