Skip to content

Further enhance the optional DocumentationHero background #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

dobromir-hristov
Copy link
Contributor

@dobromir-hristov dobromir-hristov commented Aug 23, 2022

Bug/issue #, if applicable: 97716923

Summary

Adds extra checks to the DocumentationHero enhanced background logic, to check the topicSectionsStyle for grid-like styles. Adds extra prop to enable bypassing the check and disable directly.

Dependencies

Testing

Build an archive via swiftlang/swift-docc#368

Steps:

  1. Assert that pages with topicSectionsStyle that are detailedGrid or compactGrid do not render an enhanced hero bg.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran npm test, and it succeeded
  • Updated documentation if necessary

@dobromir-hristov dobromir-hristov force-pushed the dhristov/r97716923-optional-doc-hero branch 2 times, most recently from b16c6e1 to 14ab26b Compare September 7, 2022 14:21
@dobromir-hristov dobromir-hristov force-pushed the dhristov/r97716923-optional-doc-hero branch from 14ab26b to 09302d4 Compare September 19, 2022 09:23
…e is a grid, or via a prop from DocumentationTopic
@dobromir-hristov dobromir-hristov force-pushed the dhristov/r97716923-optional-doc-hero branch from 09302d4 to c264299 Compare September 21, 2022 06:24
@dobromir-hristov dobromir-hristov marked this pull request as ready for review September 21, 2022 06:25
@dobromir-hristov
Copy link
Contributor Author

@swift-ci test

Copy link
Member

@marinaaisa marinaaisa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@dobromir-hristov
Copy link
Contributor Author

@swift-ci test

@dobromir-hristov dobromir-hristov merged commit 5108cdf into swiftlang:main Sep 21, 2022
@dobromir-hristov dobromir-hristov deleted the dhristov/r97716923-optional-doc-hero branch September 21, 2022 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants