Update README in components directory

Created on 12 September 2024, 3 months ago
Updated 19 September 2024, 3 months ago

Problem/Motivation

The README.mdx file in the components directory of a subtheme is vague and has an error.

Currently says:

For a quick start you may copy/paste all the components or those you need from the parent radix theme under `radix/src/components` into this directory

Also make sure that you import the `init.scss` into your components SASS file, the `block` component has been moved into the subtheme as an example

It would be more helpful if it mentioned the step of modifying template files and pointed to the detailed documentation.

The path to the radix components directory is incorrect.

Proposed resolution

Change it to something along these lines.

For a quick start you may:

1. Copy/paste all the components or those you need from the parent radix 
theme under `radix/components` into this directory.

2. Modify any corresponding template files in your sub-theme to use the 
copied components instead of the parent radix components.

Also make sure that you import the `init.scss` into your components SASS 
file, the `block` component has been moved into the subtheme as an example

For more information, see the [Radix documentation on copying and modifying components](https://radix.trydrupal.com/radix/working-with-the-components/copy-and-modify-a-component).

Also, I don't think that the block component was moved in my case when I created the sub-theme. If the block component is no longer moved into the sub-theme, that part of the text should be removed.

πŸ“Œ Task
Status

Fixed

Version

6.0

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States kentr

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

Comments & Activities

Production build 0.71.5 2024