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

Add instructions for adding custom components #5

Open
haydn opened this issue May 7, 2021 · 2 comments · May be fixed by #9
Open

Add instructions for adding custom components #5

haydn opened this issue May 7, 2021 · 2 comments · May be fixed by #9
Assignees

Comments

@haydn
Copy link
Member

haydn commented May 7, 2021

After the "getting started" section, we'll should explain how to add your own components into config.js.

@Mxchaeltrxn
Copy link
Member

@haydn I could probably have a go at this. I don't know if it's worth me writing up the docs (in markdown) and then having you translate it into something visually nice or if you should just write it up and make it look nice in one go.

@haydn
Copy link
Member Author

haydn commented May 9, 2021

@Mxchaeltrxn Go for it if you're keen! IMO the most important thing to explain is what each of the fields are when adding a new component into the config (type, options, init, validate and render). Even if there's no visuals at this stage it'll help anyone viewing the website an better understanding of how Sketchbook works.

If you'd like me to review it beforehand, feel free to open a PR.

@Mxchaeltrxn Mxchaeltrxn self-assigned this Jun 21, 2021
@Mxchaeltrxn Mxchaeltrxn linked a pull request Jun 23, 2021 that will close this issue
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 a pull request may close this issue.

2 participants