registry icon indicating copy to clipboard operation
registry copied to clipboard

make it easier for folks to add how-to guides

Open susanev opened this issue 4 years ago • 0 comments

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

overview

right-now in order for a package to have how-to guides those guides must be named correctly and exist in the examples repo; this makes it difficult (or impossible) for community folks to author how-to guides. lets fix this.

eng specifics

from @praneetloke

The current process of having how-to guides in the examples repo and then creating how-to guides from them by running the mktutorial tool won’t scale for contributed packages. We could, as a stop-gap, update that tool with the additional package names that it should look for when it process the folders in that repo. I would rather that we update our workflow in the registry to read, say, an examples folder from the package and generate how-to guides from that.

related internal slack convo

susanev avatar Oct 19 '21 16:10 susanev