Child of #2323895: [Meta] Document format/content of various YML files (we have been discussing how to document *.yml files).
There are files in Drupal core called *.breakpoints.yml
There is no documentation in Drupal Core on api.drupal.org about what these files are or their syntax.
They are related to responsive styling, so I think we should probably have a Responsive Styling and Breakpoints topic on api.drupal.org (linked from the landing page for Drupal 8) that would give the basics (for module and theme developers) and describe the breakpoints.yml file.
The only information I have found as a starting point is:
- The hook_help() for the breakpoint and responsive_image modules
- The corresponding pages on drupal.org, which are marked as being outdated and needing more information:
https://www.drupal.org/documentation/modules/breakpoint
https://www.drupal.org/documentation/modules/responsive_image
Comments
Comment #1
kattekrab CreditAttribution: kattekrab commentedAnd the documentation in Drupal itself is confusing and circular.
It links to https://www.drupal.org/project/breakpoint_ui which has seen no activity for over 2 years. It also links to the outdated online docs mentioned in the IS.
Comment #2
kattekrab CreditAttribution: kattekrab commentedComment #3
kattekrab CreditAttribution: kattekrab commentedI added #2398847: Remove reference to Breakpoint_UI module from Breakpoint module help text. with a patch and marked as a related issue.
Comment #4
jhodgdonThanks @kattekrab! We still need to fix the developer docs too.
Comment #5
kattekrab CreditAttribution: kattekrab commentedI wonder if any of the docs for the D7 breakpoint module would be a good starting point?
https://www.drupal.org/project/breakpoints But that DOES seem to have a UI, so maybe not.
I'll go rustle up some front end folk to see if they can help here.
D.
Comment #16
larowlanComment #19
ravi kant CreditAttribution: ravi kant at Specbee commentedThe last comment was since 2008. But I got a document for breakpoint and the URL is https://www.drupal.org/docs/theming-drupal/working-with-breakpoints-in-drupal
Comment #20
ravi kant CreditAttribution: ravi kant at Specbee commentedComment #21
smustgrave CreditAttribution: smustgrave at Mobomo commentedWhich the URL in the IS redirects to.
I think this can be closed out but will leave 3 months for original reporter to let us know if anything needs to be done.