You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With so much going on, I thought it could be useful to try to consolidate all of the tasks that will need to be completed before we can consider the library at v1. We can branch off individual tasks into their own issues as need be, but at the moment it would be nice to get a big picture of everything that's left to do.
In my mind, I'd imagined that a v1 release would essentially expose all of the main functionality found in the official Shortcuts app. That includes:
Supporting all 312 built-in actions.
Full support for creating and using variables.
Ability to choose an icon colour and glyph for the generated Shortcut
Import Questions - This hasn't been looked at at all, as far as I'm aware.
I'm probably missing some things here, so please let me know and I'll add it in.
As an aside, I'd also like to come up with a better documentation solution before hitting v1. The current docs are just ok and, while they're better than the previous solution (using jsdoc), they're still not fantastic. I get the feeling we're going to have to roll our own solution, as none of the out-of-the-box options are quite right. Hopefully we'll be able to base this custom solution on the JSON output from typedoc as that won't require any changes to the code, and typedoc is actually pretty good at what it does.
Thanks again to everyone for their contributions! 💙
The text was updated successfully, but these errors were encountered:
Hopefully we'll be able to base this custom solution on the JSON output from typedoc as that won't require any changes to the code, and typedoc is actually pretty good at what it does.
Few days ago I created a local branch with some customization to the default/minimal theme of TypeDoc (TypeStrong/typedoc-default-themes). I didn't thought to look for an exported/compiled JSON output at all.. that would be more than great: that would be awesome.
There's a problem with the current TypeDoc implementation: it cannot specify what kind of WFSerialization is allowed to be passed to an action parameter. There are parameters that can accept only an askWhenRun global variable, other ones that can only accept strings or withVariable serializations. That's something that should be worked on in the docs.
There's been a lot going on with Shortcuts JS since launch, the vast majority of which has been thanks to work done by our Contributors, so a massive thank you to @pietropizzi, @Archez, @DanielRuf, @xAlien95, @gcordalis, @JB1905, @bachya, and @ikaikastine. 🎉
With so much going on, I thought it could be useful to try to consolidate all of the tasks that will need to be completed before we can consider the library at v1. We can branch off individual tasks into their own issues as need be, but at the moment it would be nice to get a big picture of everything that's left to do.
In my mind, I'd imagined that a v1 release would essentially expose all of the main functionality found in the official Shortcuts app. That includes:
Progress with these items so far is as follows:
I'm probably missing some things here, so please let me know and I'll add it in.
As an aside, I'd also like to come up with a better documentation solution before hitting v1. The current docs are just ok and, while they're better than the previous solution (using
jsdoc
), they're still not fantastic. I get the feeling we're going to have to roll our own solution, as none of the out-of-the-box options are quite right. Hopefully we'll be able to base this custom solution on the JSON output fromtypedoc
as that won't require any changes to the code, andtypedoc
is actually pretty good at what it does.Thanks again to everyone for their contributions! 💙
The text was updated successfully, but these errors were encountered: