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 module would benefit from kick-off files #12

Open
EdmundsEcho opened this issue Aug 14, 2017 · 6 comments
Open

Documentation module would benefit from kick-off files #12

EdmundsEcho opened this issue Aug 14, 2017 · 6 comments

Comments

@EdmundsEcho
Copy link

Great work on ps. I tried to be selective in what I pulled from this repository e.g., just the generateComponentsData.js file to then build alongside with your work. I quickly got caught pulling in one file after the other to get the first to compile. In the end, pulling all if the files with the final results already coded. If you have a bare min set of files to get started that help me exploit the benefits of the course. Thanks. - E

@coryhouse
Copy link
Owner

Great point - I can appreciate how that would be useful. You're saying you didn't want to have to go through the Documentation module to set up the environment, correct? You'd rather just download a completed environment so you can skip ahead to the next module?

Just want to assure I'm understanding your use case.

@EdmundsEcho
Copy link
Author

Correct.

I'm going through Creating Reusable React Components (call it CRRC - on pluralsight). I worked through a couple of your other titles including creating a dev environment. I tried initially to tweak/adjust the configuration from one of your other titles to work on CRRC. The available resources on the ps CRRC website only had pdfs (it seemed); this github only has the completed project (or near so as best I can tell not having completed the course). It would be great to provide a starting point that includes a working config and outline of the directory structure (optional but helpful). That way we can opt to build the code ourselves along the way. The CRRC course is useful at many levels including consolidating some of the most recent methods for coding components. Finally, you do seem to make efforts to reference/contextualize across your other titles; where feasible it might be useful to qualify how this configuration differs from what you did earlier (as a side-note).

@EdmundsEcho
Copy link
Author

Quick question/idea: I'm also a big advocate for testing along the way. I wonder how the documentation might not include the code required to test the basic functionality and/or provide templates for something more involved? What do you think?

@coryhouse
Copy link
Owner

Since this course uses create-react-app, testing is supported out of the box using Jest. I showed how it works in the testing module. This repo is merely a compliment to the course and isn't intended to stand on its own, so that's why I've omitted docs on testing and other details. I assume the user is going watch the course. Does that make sense?

@EdmundsEcho
Copy link
Author

EdmundsEcho commented Aug 24, 2017 via email

@coryhouse
Copy link
Owner

coryhouse commented Aug 25, 2017

Hi Edmund - Thanks so much for the thoughtful advice! I agree that these are confusing topics so I'll certainly keep these areas in mind for future updates/courses.

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

No branches or pull requests

2 participants