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

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

Open
4 of 14 tasks
Tracked by #21
stevejpurves opened this issue Feb 2, 2023 · 8 comments
Open
4 of 14 tasks
Tracked by #21
Labels
documentation Improvements or additions to the documentation

Comments

@stevejpurves
Copy link
Collaborator

stevejpurves commented Feb 2, 2023

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.

  • add a quickstart guide for thebe + binder
  • add a quickstart guide for thebe + lite
  • add detailed docs on thebe-react
    • overview
    • 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
      • readme in lite repo
      • in thebe docs
@stevejpurves stevejpurves added the documentation Improvements or additions to the documentation label Feb 2, 2023
@stevejpurves stevejpurves mentioned this issue Feb 2, 2023
18 tasks
@stevejpurves stevejpurves changed the title Update RTD documentation to include core, lite and recent changes Update documentation to include core, lite and recent changes May 29, 2023
@stevejpurves stevejpurves changed the title Update documentation to include core, lite and recent changes Update documentation to include core, lite, react and recent changes May 29, 2023
@stevejpurves
Copy link
Collaborator Author

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

@shaielc
Copy link
Contributor

shaielc commented Jun 16, 2023

myst Link returns 404

@rowanc1
Copy link
Member

rowanc1 commented Jun 16, 2023

@stevejpurves I haven't brought these back yet after the rebrand yesterday:
executablebooks/team-compass#21

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

@shaielc
Copy link
Contributor

shaielc commented Jun 16, 2023

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

@rowanc1
Copy link
Member

rowanc1 commented Jun 16, 2023

The interim docs should now be live.

@stevejpurves
Copy link
Collaborator Author

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!

@kno10
Copy link
Contributor

kno10 commented Feb 14, 2024

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?

@stevejpurves
Copy link
Collaborator Author

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

<script src="https://unpkg.com/thebe@0.8.2/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".

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

No branches or pull requests

4 participants