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

Add note to tutorial how to update myst-cli #265

Closed
kolibril13 opened this issue Feb 24, 2023 · 5 comments
Closed

Add note to tutorial how to update myst-cli #265

kolibril13 opened this issue Feb 24, 2023 · 5 comments
Labels
story Feature request or idea to improve mystjs

Comments

@kolibril13
Copy link
Contributor

Which area is this feature request for?

Other

Describe the feature you'd like to request

It would be nice to have a section in https://myst-tools.org/docs/mystjs/quickstart that describes how to update to the latest version of myst-cli. I think it's npm update myst-cli but I don't know npm so well, so I am not sure if this is the supposed way.

Also, there are some other versions showing from myst and mystjs which I people (or at least me :D ) might get confused by:

jan-hendrik@JanHendriksAir mystjs-minimal-example % npm view myst version
0.0.1-alpha
jan-hendrik@JanHendriksAir mystjs-minimal-example % npm view mystjs version
0.0.15
jan-hendrik@JanHendriksAir mystjs-minimal-example % npm view myst-cli version
0.1.17
jan-hendrik@JanHendriksAir mystjs-minimal-example % 

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

@kolibril13 kolibril13 added the story Feature request or idea to improve mystjs label Feb 24, 2023
@rowanc1
Copy link
Member

rowanc1 commented Mar 2, 2023

Hi @kolibril13 -- there is a section here:
https://myst-tools.org/docs/mystjs/installing#updating-myst

I wonder if you want to take a crack at moving this to the quickstart guide? I think it can be duplicated -- and if you want you can use the {embed} directive.

Let me know -- otherwise I can take a go at this early next week!

(Also ... #100 ... 🔜)

@kolibril13
Copy link
Contributor Author

Hii @rowanc1,

Looking forward to that search field, that's the feature I use most when reading docs :)
Here is the pr: #288
(I did not know how to use {embed} there, so I just copied and pasted the content)

Also, it looks a bit unusual to have two installation guides, but I can see the reason why that's the case and I also don't have a better idea.
image

@rowanc1
Copy link
Member

rowanc1 commented Mar 2, 2023

Nice, thank you! It is live!

https://myst-tools.org/docs/mystjs/quickstart#installing-the-myst-cli

Yeah, I agree on the two pages, I am not totally sure that we need the second one anymore at all. The only thing that doesn't have an alternative home is the latex install comments (which aren't very comprehensive anyways). My thinking was that we might have that as a troubleshooting guide/reference material that goes into a lot more depth than the quickstart.

It could also be something like "installing dependencies" or something and merge with the page below it? (latex, npm/node, imagemagik, inkscape).

If you have specific thoughts on how to improve this, always welcome PRs! :)

Agree, I miss search a lot ... it will get done!

@rowanc1
Copy link
Member

rowanc1 commented Mar 2, 2023

I am going to close this specific issue! Thanks again for the PR.

And -- we should document the embed syntax @fwkoch, it is pretty cool. :)

@rowanc1 rowanc1 closed this as completed Mar 2, 2023
@kolibril13
Copy link
Contributor Author

troubleshooting guide/reference

sounds good, that would probably be a bit similar to an FAQ.
Maybe these resources can also be linked to at the end of the quickstart installation chapter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
story Feature request or idea to improve mystjs
Projects
None yet
Development

No branches or pull requests

2 participants