Improve Classy template in-line documentation

Created on 20 February 2015, about 10 years ago
Updated 9 April 2025, 7 days ago

Problem/Motivation

The Classy base theme in Drupal 8 contains almost every core module template. These templates are being organized in a themer-centric way β†’ , rather than just mimicking the module organization scheme. While this will certainly make some aspects of theming more intuitive, this organization may also create a disconnect between the templates in the base-theme and their associated core templates in the modules directory. Further complicating things, the exact use of some template files is not immediately obvious and needs more explanation.

Proposed resolution

Every template in Classy should include a meaningful description of what it's used for, a reference back to the original template in its associated core module, and an example link to where its output can be seen.

Remaining tasks

  1. Agree on a standard format for this documentation in template files.
  2. Add it to all the files.
πŸ“Œ Task
Status

Postponed: needs info

Version

1.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States jstoller

Live updates comments and jobs are added and updated live.
  • Needs issue summary update

    Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.

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.

  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Wonder if this is still needed actually? Classy shouldn't be the starter point for any theme, instead the starterkit_theme should be used.

Production build 0.71.5 2024