Contrib.social

Add some very basic documentation about Components

Open on Drupal.org →
Created on 23 July 2024, about 2 months ago
Updated 9 August 2024, 30 days ago

Overview

Working on a few issues on this module and I find the Component Config entity and Component plugins very confusing. functiona

I think 📌 Document the current JSON-based data model, and describe in an ADR Active will probably help but I think we could add few things real quickly that might things more clear

This module added a bunch of code that was not commented much to get some initial velocity. Partly this is was also because things are in still in flux and the code might just be replaced

I might be an outlier in being this confused but I think a tiny bit comments could go along way

Proposed resolution

Add some quick documentation in few places. Don't worry about it being perfect and they to add todos to issues that might change things like 🌱 [META] Support component types other than SDC Needs work so we know when to update or remove temp docs.

📌 Task
Status

Fixed

Component

Documentation

Created by

🇺🇸United States tedbow Ithaca, NY, USA

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

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024