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

maintaining docs for site structure #142

Merged
merged 1 commit into from
Mar 19, 2019

Conversation

choldgraf
Copy link
Collaborator

This adds some simple documentation explaining the high-level site structure.

@choldgraf
Copy link
Collaborator Author

ok I'm just gonna merge these :-) (just a note that I am at least personally fine with any of y'all just merging stuff right away)

@choldgraf choldgraf merged commit 8b5875a into jupyter-book:master Mar 19, 2019
@choldgraf choldgraf deleted the maintainer_structure branch March 19, 2019 15:10
@BENR0
Copy link

BENR0 commented Mar 20, 2019

Hey @choldgraf I think there is just a small mistake in the last sentence. The book files are in "site" under the "tests" directory not in "content".
Otherwise I think for a quick overview its fine.
One thing I often find helpful is an example case in the way: Let's say you added feature x and want to add a test for it then you need to put the test at y in file z (and add dummy data to test with to directoryf/file w).
The reason this often helps me probably is that I get an idea of how the code is layed out and what the logic of this layout might be.

@choldgraf
Copy link
Collaborator Author

@BENR0 that's a great comment - I'll open a new issue with your suggestion so we can keep track of it!

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.

3 participants