thebe icon indicating copy to clipboard operation
thebe copied to clipboard

Update documentation to include core, lite, react and recent changes

Open stevejpurves opened this issue 2 years ago • 8 comments

thebe documentation is out of date and we need to pull together docs on thebe and all it's sub-packages.

The latest thebe docs are being hosted here on myst-tools.org while RTD points to the 0.8.2 docs.

This issue marks the work needed to get the docs up to date on myst-tools.org an then once 0.9.0 goes out also redirect / host the latest docs on RTD.

  • [x] add a quickstart guide for thebe + binder
  • [ ] add a quickstart guide for thebe + lite
  • [ ] add detailed docs on thebe-react
    • [x] overview
    • [x] providers
    • [ ] notebook loading and hooks
      • [ ] gotchas on cell refs
    • [ ] UI components
  • [ ] add detailed docs on thebe-lite
  • [ ] add detailed docs on thebe-core
  • [ ] update thebe docs on RTD
    • [ ] ensure existing thebe docs build
      • [x] readme in lite repo
      • [ ] in thebe docs

stevejpurves avatar Feb 02 '23 12:02 stevejpurves

Documentation is taking shape here: https://myst-tools.org/docs/thebe

@danieleguido I've started building out the react docs here too, let me know if you have specific questions as you go and I can make sure they are addressed

stevejpurves avatar May 29 '23 17:05 stevejpurves

myst Link returns 404

shaielc avatar Jun 16 '23 13:06 shaielc

@stevejpurves I haven't brought these back yet after the rebrand yesterday: https://github.com/executablebooks/team-compass/issues/21

I could use five minutes of your time today to fix that!

rowanc1 avatar Jun 16 '23 13:06 rowanc1

https://mystmd.org/docs/thebe also gives a 404

shaielc avatar Jun 16 '23 14:06 shaielc

The interim docs should now be live.

rowanc1 avatar Jun 16 '23 15:06 rowanc1

Thanks @rowanc1 -- i've caused some confusion here - the current latest docs are on a branch, which I have just re-deployed. These are a wip but reflect the latest APIs https://mystmd.org/thebe - @shaielc I'm happy to prioritize writing new docs sections in response to any specific questions you have!

stevejpurves avatar Jun 19 '23 09:06 stevejpurves

thebe-lite documentation says

<script src="https://unpkg.com/thebe@latest/dist/lib/index.js"></script>

but that URL is 404. Is this supposed to be https://unpkg.com/thebe-core@latest/dist/lib/thebe-core.min.js?

kno10 avatar Feb 14 '24 13:02 kno10

@kno10 there's a mistake in the link, it should be:

<script src="https://unpkg.com/[email protected]/lib/index.js"></script>

thebe-core can be loaded like that too, but has none of the code that attaches to the page, finds code cells, or inserts codemirror editors. thebe is the package intended for quickly making a page "live".

stevejpurves avatar Feb 15 '24 10:02 stevejpurves