Skip to content

Add support for @TopicsVisualStyle #419

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: 97716047

Summary

This PR add support to both the new docc @TopicsVisualStyle directive.

image
image

Note:
This PR assumes the RenderJSON based on some early discussions. It should be double checked when the DocC PR for this lands.

Dependencies

This PR builds on top of the work from a few other PRs:

#418
#409
#417
Docc PR - swiftlang/swift-docc#368

Testing

Steps:

  1. Mount the provided doccarchive
  2. Assert the Topics are hidden - http://localhost:8080/documentation/slothcreator/sloth
  3. Assert the Topics section is a detailedGrid - http://localhost:8080/documentation/slothcreator/slothgenerator
  4. Assert the Topics section is a compactGrid - http://localhost:8080/documentation/slothcreator/namegenerator

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

@ethan-kusters
Copy link
Contributor

@dobromir-hristov dobromir-hristov mentioned this pull request Sep 7, 2022
3 tasks
@dobromir-hristov dobromir-hristov force-pushed the dhristov/r97716047-support-links-topicsSectionStyle branch 2 times, most recently from a88c8ff to f3b9e44 Compare September 7, 2022 09:30
@dobromir-hristov dobromir-hristov force-pushed the dhristov/r97716047-support-links-topicsSectionStyle branch 4 times, most recently from 974d5cb to af9423e Compare September 15, 2022 16:40
Copy link
Contributor

@mportiz08 mportiz08 left a comment

Choose a reason for hiding this comment

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

Haven't had a chance to fully test this yet, but I gave an initial look at the code (mostly ignoring the changes from the card PR)

I'll probably be able to test this with some real content tomorrow.

@dobromir-hristov
Copy link
Contributor Author

All done, give it another look.

@dobromir-hristov dobromir-hristov force-pushed the dhristov/r97716047-support-links-topicsSectionStyle branch 2 times, most recently from db887fc to 7c0f4d6 Compare September 20, 2022 09:04
@dobromir-hristov dobromir-hristov force-pushed the dhristov/r97716047-support-links-topicsSectionStyle branch from 7c0f4d6 to 928a1d5 Compare September 20, 2022 15:55
@dobromir-hristov dobromir-hristov marked this pull request as ready for review September 20, 2022 15:55
@dobromir-hristov
Copy link
Contributor Author

@swift-ci test

@dobromir-hristov
Copy link
Contributor Author

@swift-ci test

@dobromir-hristov dobromir-hristov merged commit 3c2d601 into swiftlang:main Sep 20, 2022
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.

3 participants