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

Provide a visual description of the Executable Books stack, its components, and how they fit together #836

Open
choldgraf opened this issue Oct 6, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@choldgraf
Copy link
Member

choldgraf commented Oct 6, 2022

Context

We now have many different projects at various levels of the stack. Some of these are building blocks, some of them are high-level integrators of those building blocks. Some are for end-users, some are more developer-facing. It is hard to navigate all of these projects, understand how they fit together, etc.

We describe the tools in the stack here as well as in jupyter book but neither does a good job of explaining how all the pieces fit together.

We have an excalidraw draft of the Jupyter Book stack here. It just hasn't been added yet.

Proposal

We should provide a centralized documentation that shows off the major parts of the Python/Sphinx stack, as well as the major parts of the JavaScript/MySTJS stack. These should provide a way for people to quickly understand how the pieces fit together, and have pointers to more in-depth docs for each component.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant