Skip to content

docs: update docs for user-event from readme #892

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jul 21, 2021
Merged

docs: update docs for user-event from readme #892

merged 4 commits into from
Jul 21, 2021

Conversation

nickserv
Copy link
Member

No description provided.

MatanBobi
MatanBobi approved these changes Jul 20, 2021
View reviewed changes
@nickserv nickserv changed the title docs: update docs for user-event docs: update docs for user-event from readme Jul 20, 2021
@nickserv nickserv mentioned this pull request Jul 20, 2021
Closed
@nickserv nickserv requested a review from MatanBobi July 20, 2021 17:49
@nickserv
Copy link
Member Author

nickserv commented Jul 20, 2021 •
edited
Loading

I've also thought about splitting up the Installation and API into separate packages like the framework packages. Is this something we could do in the ecosystem section, and if so is it worth trying for user-event?

MatanBobi
MatanBobi approved these changes Jul 21, 2021
View reviewed changes
Copy link
Member

@MatanBobi MatanBobi left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

About splitting the page to two pages, I believe it's worth doing, especially if we're planning to port the whole documentation for user-event into the docs site (Which I think is the right approach). I'm starting to think that user-event should have it's own place since even though it's a part of the eco-system, it's a pretty important package for us.

@nickserv
Copy link
Member Author

nickserv commented Jul 21, 2021 •
edited
Loading

I'm going to merge this now, since the user-event readme already links here and we don't want the docs to be out of date. However, I'll probably try to split this up in another PR soon.

I'm starting to think that user-event should have it's own place since even though it's a part of the eco-system, it's a pretty important package for us.

How would this be represented in the sidebar?

@nickserv nickserv merged commit af35066 into main Jul 21, 2021
@nickserv nickserv deleted the update-docs branch July 21, 2021 22:25
@MatanBobi
Copy link
Member

I'm going to merge this now, since the user-event readme already links here and we don't want the docs to be out of date. However, I'll probably try to split this up in another PR soon.

I'm starting to think that user-event should have it's own place since even though it's a part of the eco-system, it's a pretty important package for us.

How would this be represented in the sidebar?

@nickmccurdy It can be the same as the frameworks section, I'm imagining something like this:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MatanBobi MatanBobi MatanBobi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nickserv @MatanBobi