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

Enhanced documentation #645

Open
Jonghakseo opened this issue Aug 6, 2024 · 4 comments
Open

Enhanced documentation #645

Jonghakseo opened this issue Aug 6, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@Jonghakseo
Copy link
Owner

Is your feature request related to a problem? Please describe.

As reported in several issues, creating the extension itself, and using this boilerplate in the process, requires more explanation.

Describe the solution you'd like

More detailed and improved documentation is needed. We are thinking of documentation based on each package's README.md, but it may be necessary to provide a self-hosted documentation page.

Describe alternatives you've considered

I think we can share information in the Discord community before documenting it.

Additional context
Add any other context or screenshots about the feature request here.

@Jonghakseo Jonghakseo added the enhancement New feature or request label Aug 6, 2024
@Jonghakseo Jonghakseo self-assigned this Aug 6, 2024
@Jonghakseo Jonghakseo pinned this issue Aug 6, 2024
@Jonghakseo Jonghakseo added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Aug 6, 2024
@PatrykKuniczak
Copy link
Collaborator

Basing on that comment: #651 (comment)

I think good idea is to add tutorials to the most popular lib, as MUI/Chakra UI/Radix and so on to new DOCS as we have on the legacy version

@Jonghakseo
Copy link
Owner Author

@PatrykKuniczak

I agree. I want to turn Markdown files in this repository into a webpage as it is.

https://github.com/wranders/markdown-to-pages-action

I'm looking at something like the project above.

@PatrykKuniczak
Copy link
Collaborator

@PatrykKuniczak

I agree. I want to turn Markdown files in this repository into a webpage as it is.

https://github.com/wranders/markdown-to-pages-action

I'm looking at something like the project above.

I haven't heard about it in the past, that's interesting, because we don't need any new hosting, github pages are free 😁

@dandv
Copy link
Contributor

dandv commented Dec 5, 2024

I've improved the README a bit but I agree that the documentation assumes users know how Chrome extensions work. Maybe it's better that way, to avoid everyone and their dog from publishing half-baked extensions.

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 enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants