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

Improve the developer documentation #233

Open
choldgraf opened this issue Aug 13, 2020 · 3 comments
Open

Improve the developer documentation #233

choldgraf opened this issue Aug 13, 2020 · 3 comments

Comments

@choldgraf
Copy link
Collaborator

I've added a first pass at developer documentation here:

https://thebe.readthedocs.io/en/latest/contribute.html

However I think we are missing some important pieces in there. I wonder if @minrk, @rowanc1, @chrisjsewell, or @joelachance would be willing to confirm or add the following:

  • Installation and local build instructions
  • How to make a release for thebe
  • An explanation of the JupyterLab API that we are using
  • Any best-practices resources for using npm/javascript dev workflows

I would do it myself but I don't really know anything about javascript! 😬😬😬

@minrk
Copy link
Collaborator

minrk commented Oct 16, 2020

added some more in #248 and the scaffolding for js API docs here, so we can have nice docs coverage like we are used to.

@rowanc1
Copy link
Collaborator

rowanc1 commented Oct 17, 2020

One of the things that I am not completely sure about, is which package we are pointing to, and when it was last released! I think we should be pointing to thebe on unpkg rather than thebelab - one was updated 2 months ago, rather than a year.

You can also deprecate thebelab on NPM if you like, and you can undo that as well:
https://docs.npmjs.com/deprecating-and-undeprecating-packages-or-package-versions

If puts a notice to users that shows up in console and in the top of NPM:

npm deprecate thebelab "🛑  `thebelab` has been renamed to `thebe`, you can install the new version: `npm install thebe` 🚀"

@choldgraf
Copy link
Collaborator Author

I didn't realize that there was a release of thebe on unpkg...if that's the case, we should definitely be pointing to it instead of thebelab 😬

@stevejpurves stevejpurves moved this from In progress to Done in Jupyter Con 2020 Sprint Sep 1, 2021
@stevejpurves stevejpurves added this to Ready in General Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants