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

chore: add readme quick start #247

Merged
merged 4 commits into from
May 16, 2022

Conversation

dskamiotis
Copy link
Contributor

@dskamiotis dskamiotis commented May 12, 2022

What does this change?

We do not have a general quick start guide to help all users of prosemirror-elelements to quickly and easily create an element.

How to test

Check the doc in its markdown form for both structure and content for accuracy :)

Checked the layout in https://dillinger.io/

@dskamiotis dskamiotis changed the title add readme quick start feat: add readme quick start May 12, 2022
@dskamiotis dskamiotis requested a review from a team May 12, 2022 11:20
@dskamiotis dskamiotis force-pushed the ds/quick-start-add-element-guide-readme branch from d83fcee to f5c03da Compare May 12, 2022 11:25
@dskamiotis dskamiotis force-pushed the ds/quick-start-add-element-guide-readme branch from f5c03da to 9e43ac0 Compare May 12, 2022 11:32
Copy link
Contributor

@jonathonherbert jonathonherbert left a comment

Choose a reason for hiding this comment

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

Great start! A few comments. We can expand these docs further to include mounting the component in the demo once that's in a clearer state.

docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
dskamiotis and others added 3 commits May 13, 2022 10:21
Co-authored-by: Jonathon Herbert <jonathon.herbert@guardian.co.uk>
Co-authored-by: Jonathon Herbert <jonathon.herbert@guardian.co.uk>
@dskamiotis dskamiotis changed the title feat: add readme quick start chore: add readme quick start May 13, 2022
@dskamiotis dskamiotis merged commit afa0567 into main May 16, 2022
@dskamiotis dskamiotis deleted the ds/quick-start-add-element-guide-readme branch May 16, 2022 08:01
@github-actions
Copy link
Contributor

🎉 This PR is included in version 4.11.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants