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

Added multi-file brief example #265

Closed
wants to merge 4 commits into from

Conversation

IsaccBarker
Copy link
Contributor

Attempts #264

Added a brief example to the documentation about using multiple files. I'm adding this because I don't want others to waste 4 hours of their time like I did mine. I feel like this speaks for itself (correct me if I'm wrong👍).

Added a brief example to the documentation about using multiple files.
@shepmaster
Copy link
Owner

I'm always hesitant to add more details to the top-level documentation. My worry is that if everyone puts the specific pieces that are important to them there, then soon it will contain everything and there's no more organization.

I honestly don't know what is best to help people, so I don't think what you've done is wrong, but I wanted to explain my hesitation about merging it as-is. Is there anywhere in the guide that you think would be reasonable? Do you think this could be related to #212?

@IsaccBarker
Copy link
Contributor Author

IsaccBarker commented Nov 11, 2020

@shepmaster You're right about it being related to #212. I'll stop this pull-request and starting working on a section like that. Do you think it would be fitting to put a direct link to that section on the main page?

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 this pull request may close these issues.

2 participants