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

Feature - provide TypeScript examples for code blocks #113

Open
jenweber opened this issue Aug 28, 2023 · 3 comments
Open

Feature - provide TypeScript examples for code blocks #113

jenweber opened this issue Aug 28, 2023 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@jenweber
Copy link
Collaborator

jenweber commented Aug 28, 2023

In #112 we introduced the tooling needed to show both TypeScript and JS examples in the cheatsheet. Here's what we need to do next to get those examples available to users:

  • Make a toggle for switching between JS and TS. Ideally, this toggle could go into the ember-styleguide so it can be reused as a visual component and as a UX pattern https://github.com/ember-learn/ember-styleguide (non blocking for launch of TS examples - we could use ember-shiki's built in tabs for MVP)
  • Write some TS examples
  • Generate the JS from the TS whenever a TS example is available. We'd like for this to have a small diff between the JS and the TS. The good news is that @wycats has done something like this for Starbeam docs, which we can borrow from! The goal is to write just the TS example and not maintain both TS and JS by hand.
  • Show the TS examples by tabs and/or global toggle

This work could be done in a series of incremental PRs, or all at once if someone is on a roll!

@jenweber
Copy link
Collaborator Author

jenweber commented Sep 1, 2023

@IgnaceMaes is this something you are interested in helping with? I was going to add the help-wanted label but thought I should check with you first before we ask for other volunteers. Let me know what you think!

@IgnaceMaes
Copy link
Member

It's an interesting one, but realistically not one that I would be able to look into in the near future. So adding the help-wanted label would be a good idea!

@acorncom acorncom added the help wanted Extra attention is needed label Sep 30, 2023
@acorncom
Copy link
Member

👍 label added

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants