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

Documentation: Create more examples #179

Open
ndabAP opened this issue Jun 16, 2020 · 3 comments
Open

Documentation: Create more examples #179

ndabAP opened this issue Jun 16, 2020 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@ndabAP
Copy link
Owner

ndabAP commented Jun 16, 2020

The main site has only one big example. Create multiple examples how to use the library with code examples. A complete redesign is absolutely possible.

You find the documentation source code here. Start it with npm run serve.

@ndabAP ndabAP added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jun 16, 2020
@shaenr
Copy link

shaenr commented Sep 12, 2020

Just to add, because I've been looking over your code and seeing what I can maybe do with it for my needs, but still being kind of new-ish at Vue -- I think more helpful than more example commands would be, "To make a new command that is not writing a string into a component, you need to look here in this file in and take x into account, look in y file and take that into account.

The Auto Complete stuff seems the most heavy I guess. It took me a while to figure out what providing and injecting was but I got it eventually. Either way, examples would be cool, but mainly only if they are instructional in how to add to the engine without breaking it.

@shaenr
Copy link

shaenr commented Sep 12, 2020

Actually, many of the things you said in the README confused me thoroughly, being pretty new to JS frameworks. But after I looked through all your code and went back and read it, I understand.

@ndabAP
Copy link
Owner Author

ndabAP commented Sep 23, 2020

The Auto Complete stuff seems the most heavy I guess.

Definitely, and it's even not yet part of the core. You need to copy paste it from the examples. The plan was to fully integrate it but that needs careful planing. I didn't find the time so far.

Actually, many of the things you said in the README confused me thoroughly, being pretty new to JS frameworks. But after I looked through all your code and went back and read it, I understand.

I'd be very happy for contributions because most stuff is only written by me which means it's only from my perspective.

What I meant with this was more examples at the hosted site here: https://ndabap.github.io/vue-command. I thought like you have code and next to it, you see the result in the terminal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants