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

Support Sourcegraph notebooks on docs site #88

Open
jtibshirani opened this issue Jan 5, 2023 · 1 comment
Open

Support Sourcegraph notebooks on docs site #88

jtibshirani opened this issue Jan 5, 2023 · 1 comment
Labels

Comments

@jtibshirani
Copy link
Member

Our developer docs contain some code walkthroughs that would work really well as Sourcegraph notebooks. For example, I tried converting the Life of a search query docs to a notebook and found it more readable. It'd be great if docs.sourcegraph.com could show notebooks like this. If we had notebooks throughout the docs, maybe more users would learn about them and see how useful they are.

Currently, the way to do this would be to create a public notebook on https://sourcegraph.com/notebooks, and then embed that in an iframe in a docs page. But this would mean separating out important documentation from the sourcegraph/sourcegraph repo where it currently lives. It seems best to keep all the docs in one place, living alongside the code.

Maybe this would be a new notebooks feature? You could just point to the URL of a running Sourcegraph instance, plus the location of a .snb.md file, and it will render it?

@jtibshirani jtibshirani added the enhancement New feature or request label Jan 5, 2023
@jtibshirani
Copy link
Member Author

CC @novoselrok since I heard you worked on something similar -- please ignore if this isn't right!

@unknwon unknwon added feature and removed enhancement New feature or request labels Feb 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants