Problem/Motivation

We would like to include README files for each of our components that explains their functionality and provides possible code examples.

Proposed resolution

Review all outstanding components listed below and update their documentation.

Remaining tasks

  • accordion
  • accordion-item
  • breadcrumbs
  • button
  • cta
  • drupal-messages
  • figure
  • image
  • link
  • menu
  • menu—navigation
  • page-title
  • pager
  • pullquote
  • sidebar
  • tabs
  • teaser
  • video

Issue fork prototype-3416795

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

jldust created an issue. See original summary.

jldust’s picture

jldust commented
Status: Active » Closed (outdated)

Closing this in favor of component specific tickets to keep this scoped better.

jldust’s picture

jldust commented
Status: Closed (outdated) » Active

Pulling this back to address initial documentation.

b-ry made their first commit to this issue’s fork.

b-ry’s picture

b-ry commented

jldust, I added the initial round or README.md files to the components with missing files.

jldust opened merge request !227

jldust’s picture

jldust commented
Status: Active » Reviewed & tested by the community

This has been merged in and will be included in the next tagged release.

  • jldust committed 640b4a11 on 5.x 
    feat: #3416795 SDC Components: Add README docs...
jldust’s picture

jldust commented
Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

jldust’s picture

jldust commented
Status: Fixed » Closed (fixed)