Skip to content

Include Relationship section in minimized mode #868

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

Merged
merged 6 commits into from
Jul 3, 2024

Conversation

hqhhuang
Copy link
Contributor

Bug/issue #, if applicable: rdar://81022077

Summary

Include Relationship section in minimized mode

Dependencies

NA

Testing

Steps:

  1. Manually test in Quick Nav to ensure there are no regressions and the relationship info is displayed

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

hqhhuang added 4 commits June 17, 2024 16:46
show `Relationships` in minimized mode
Fix spacing and move view more link to the bottom
…hips`

update tests for `DocumentationTopic`, `ContentTable`, and `Relationships`
fix declaration container margin
@hqhhuang hqhhuang requested review from mportiz08 and marinaaisa June 24, 2024 21:58
@hqhhuang hqhhuang requested a review from mportiz08 June 25, 2024 00:04
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.

Seems to be working well on a functional level.

As we discussed in person, the code for the "minimized" layout of documentation pages is starting to get pretty spread out and messy, but we may have to refactor things entirely using a new top-level component if we want to clean things up at this point. We may want to consider that in the future if we need to enhance this layout more.

@@ -44,6 +45,10 @@ export default {
type: Array,
required: true,
},
enableMinimized: {
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think you need to change this, but in the future it might be worth considering provide/inject for situations like this where you're adding props to a component solely for the purpose of passing it down to further nested children.

@hqhhuang
Copy link
Contributor Author

hqhhuang commented Jul 3, 2024

@swift-ci test

@hqhhuang hqhhuang merged commit 44c3a2c into swiftlang:main Jul 3, 2024
1 check passed
@hqhhuang hqhhuang deleted the include-relationship-in-minimized branch July 3, 2024 22:28
hqhhuang added a commit to hqhhuang/swift-docc-render that referenced this pull request Jul 3, 2024
…/81022077

Include Relationship section in minimized mode (swiftlang#868) rdar://81022077
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