Create SDC "Quick start" documentation / code

Created on 5 April 2023, almost 2 years ago
Updated 2 June 2023, over 1 year ago

This is not a beta blocker, however we want this to be live by DrupalCon Pittsburgh 2023 at the latest.

We want to give front-enders some "quick start" components that they immediately start messing around with (and evaluate SDC).

We're not quite sure what this would look like, but some ideas include

  • A zip file to download and extract in your theme's directory
  • Documentation where you can copy and paste
  • A repo on github
  • ???
πŸ“Œ Task
Status

Fixed

Version

11.0 πŸ”₯

Component
DocumentationΒ  β†’

Last updated 29 minutes ago

No maintainer
Created by

πŸ‡ΊπŸ‡ΈUnited States mherchel Gainesville, FL, US

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

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Issue created by @mherchel
  • i would look for three tutorials to jumpstart:
    1. how to generate a pattern/component/story thing
    2. how to view it in a living styleguide independent of my site or theme
    3. how to use it in conjunction with my site and theme

  • e0ipso Can Picafort

    The SDC Examples β†’ module is an attempt to this. I am not sure if it addresses all the needs for this, but it may be a good start.

    Is this enough for this ticket?

  • Assigned to mherchel
  • πŸ‡ΊπŸ‡ΈUnited States mherchel Gainesville, FL, US
  • Status changed to Needs review over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States mherchel Gainesville, FL, US

    Documentation created at https://www.drupal.org/docs/develop/theming-drupal/using-single-director... β†’

    Would love to have some eyes on it!

  • πŸ‡ΊπŸ‡ΈUnited States mherchel Gainesville, FL, US
  • Status changed to RTBC over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States josh.fabean

    I just tested that documentation and was able to recreate the screenshot on the bottom by only copy and pasting the code samples, so it all works as it should.

  • Status changed to Fixed over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States mherchel Gainesville, FL, US

    Thanks for this! Marking as fixed πŸ™Œ

  • πŸ‡ΊπŸ‡ΈUnited States cosmicdreams Minneapolis/St. Paul

    Reviewed the documentation, I think it's a lot to ask of a developer to read through all of this in order to entertain the idea that they should start using SDC in their builds.

    I see from above that it was recommended that we could just point users to the sdc_examples module. I think that's a good idea. Perhaps we can alter the documentation to walk users through and explain the anatomy of a component why pointing to the examples. With how the documentation is currently written, I am lead to believe that I must create a component as complicated as the one shown in order for the effort to be worthwhile. But components can be far simplier. The system is intended to allow components to be a simple as possible.

    I think this page leads the reader down the wrong path.

  • Status changed to Needs work over 1 year ago
  • e0ipso Can Picafort

    I think we should see if we can use collapsible elements to improve readability. This is a great start, but we likely want to keep iterating based on the ideas above.

  • Status changed to Fixed over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States mherchel Gainesville, FL, US

    Reviewed the documentation, I think it's a lot to ask of a developer to read through all of this in order to entertain the idea that they should start using SDC in their builds.

    I see from above that it was recommended that we could just point users to the sdc_examples module. I think that's a good idea. Perhaps we can alter the documentation to walk users through and explain the anatomy of a component why pointing to the examples. With how the documentation is currently written, I am lead to believe that I must create a component as complicated as the one shown in order for the effort to be worthwhile. But components can be far simplier. The system is intended to allow components to be a simple as possible.

    I think this page leads the reader down the wrong path.

    I really disagree with this (as we discussed in Slack).

    Marking again as fixed. Feel free to open and link followup issues if you disagree.

  • e0ipso Can Picafort

    I might have missed the Slack conversation.

  • πŸ‡ΊπŸ‡ΈUnited States mherchel Gainesville, FL, US

    yeah, no worries. Sorry if I came across as grumpy! :D

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024