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 to mystmd branding #447

Merged
merged 3 commits into from
Jul 3, 2023
Merged

📖 Update to mystmd branding #447

merged 3 commits into from
Jul 3, 2023

Conversation

rowanc1
Copy link
Member

@rowanc1 rowanc1 commented Jun 30, 2023

This is a follow on task from executablebooks/team-compass#21.

This will eventually allow a consistent install experience across pip and npm.

See #139

rowanc1 added 3 commits June 30, 2023 13:39
This is a follow on task from executablebooks/team-compass#21.

This will eventually allow a consistent install experience across pip and npm.

See #139
@rowanc1
Copy link
Member Author

rowanc1 commented Jun 30, 2023

@choldgraf tagging you in here based on our meeting from last week on this!

The change here is that the download would change from npm install -g myst-cli to npm install -g mystmd. As we talked about last week this allows us to align with eventually installing from conda and PyPI with the same name in the future (#139).

The install process I have also sped up about 17x. 🚀

As a part of this change, this would also rename the git repo to mystmd and then we have alignment across most of our various pages and doesn't turn off users who see the js part and think it isn't for them! This will also allow us to bring back some of the js-specific docs with less confusion.

Let me know if you have any thoughts on this, I would like to get this out before the webinar on Wednesday as we already looking to have quite a few folks signed up there!

@choldgraf
Copy link
Collaborator

Go for it. I think that we should double check our explanation in the future to make sure it matches the mental model people bring (eg MyST is a flavor of markdown but it is also a documentation engine?!) bit I think that will be best done after running these ideas by people, getting feedback, and making adjustments.

@rowanc1 rowanc1 merged commit b0a2a34 into main Jul 3, 2023
@rowanc1 rowanc1 deleted the feat/mystmd branch July 3, 2023 13:47
@rowanc1
Copy link
Member Author

rowanc1 commented Jul 3, 2023

Sounds good - will get this out today!

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

Successfully merging this pull request may close these issues.

2 participants