Roadmap to 1.0

[Nemikolh]

Hey there!

Thanks for showing interest in using TutorialKit! We are currently planning to do a 1.0 release and we're excited to share a list of the changes that we are intending to make before the release.

Planned Changes

• 🚨 Renaming tutorialkit to @tutorialkit/cli. So we can use that name for the vscode extension and also because the npm create tutorial command is the recommended way to create a new tutorial.
  • feat: rename tutorialkit to @tutorialkit/cli #153
• 🚨 Renaming @tutorialkit/components-react to @tutorialkit/react and move it from components/react to react. Simpler name and descriptive enough.
  • feat!: rename @tutorialkit/components-react to @tutorialkit/react #155
• 🚨 Update src/content/config.ts to import the full schema from @tutorialkit/types.
  • feat: add contentSchema #156
• 🚨 UnoCSS config:
  • Use a deep merge strategy and move default presets and transformers in @tutorialkit/theme.
    • feat!: simplify UnoCSS integration #270
  • Find a way to remove content.inline
    • feat!: simplify UnoCSS integration #270
• 📖 Document docs on how tow write your own component with tutorialkit:store
  • docs: add example of tutorialkit:store and tutorialkit:core usages #348
• 📖 Document that tutorialkit:core provide low level access to webcontainer and is to be used only as a last resort
  • docs: add example of tutorialkit:store and tutorialkit:core usages #348
• 📖 Document that using @tutorialkit/react without TutorialKit is experimental
  • feat!: mark @tutorialkit/react component API as experimental feature #346
• Have create-tutorial depend on "@tutorialkit/cli": "latest" and release a fire and forget version.
  • ci: separate create-tutorial releasing #146
• Remove .vscode/settings.json.
  • fix(cli): remove vs code settings.json #173
• Add TutorialKit extension to the list of recommended extension in the generated template.
  • feat(cli): add vs code extension to recommendations #172
• Extension:
  • Frontmatter autocomplete:
    • feat(extension): metadata autocompletion #143
  • Support folder-based and config-based ordering
    • feat(extension): support config-based ordering #223
  • Part, chapter, lesson deletion
    • feat(extension): support config-based ordering #223

Nice to have, some post 1.0.0 launch:

• Have the default tutorial generated showcase all of the features of TutorialKit (ala slidev)
  • Generated projects to showcase more features #358
• JSDocs on TutorialStore class
• VSCode Extension
  • Automated releases
    • CI: Automated releases for VSCode extension #356
  • Inheritance information
    • Extension: Display inherited metadata #360
  • Drag and drop ordering for lesson / chapter / parts
    • Extension: Drag and drop ordering for lesson / chapter / parts #355
• "Checks" to prevent navigation to next lesson until current checks have passed
  • Add _tests folder with a set of test file to run against the application #178
• Syntax highlighting for
  • Vue
    • feat: add Vue language to CodeMirror #256
  • Svelte
    • feat: add Svelte language to CodeMirror #212
  • Astro
    • Syntax highlight for *.astro files #357
• Monaco as an alternative option to CodeMirror
• Opt-in TypeScript intellisense
  • Can't get typescript auto complete to work on ts and tsx files #213

[Barbapapazes]

For the UnoCSS part, a similar solution to this one, https://github.com/slidevjs/slidev/blob/main/packages/slidev/node/setups/unocss.ts, used in Slidev could be used? This could help to simplify the DX and the starter.

[Nemikolh]

@Barbapapazes Thanks for the pointer! This mergeConfigs function from unocss seems to be what we're looking for 👀