Documentation updates and improvements

Created on 14 June 2023, over 1 year ago
Updated 1 September 2023, about 1 year ago

Problem/Motivation

After installing, testing and setting up a D10 site with SDC and storybook working, i've found the following improvements could be done to documentation:

  • Corrections, i.e. yarn set version berry seems to be incompatible with yarn global and other suggested corrections on other issues πŸ› Incorrect docs for working with storybook and SDC Closed: outdated
  • Propose a Node.js minimum version (taken from storybook) and specify the Storybook version that is recommended on the docs (7) to help people spin up their development environment
  • Extend the info about CORS
  • Extend the info about Storybook. Provide an annotated *.stories.yml as an example, point to the API on storybook and where/how to get examples. This has been a particular pain point as Storybook is very JS oriented and it was hard to figure out how to write a yml/json story from the official docs
  • Extend the info about how to document using *.mdx and how to integrate the yml stories into it
πŸ“Œ Task
Status

Fixed

Version

2.0

Component

Code

Created by

πŸ‡ͺπŸ‡ΈSpain idiaz.roncero Madrid

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024