Skip to content

fix: show nested device properties #655

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: show nested device properties #655

wants to merge 2 commits into from

Conversation

mikewuu
Copy link
Contributor

@mikewuu mikewuu commented Jun 14, 2025

Closes https://linear.app/seam/issue/CX-345/group-device-properties-on-docs

Previously nested properties (property with name === properties) were being shown under ## Properties as nested properties. Some of these properties themselves then had further nested properties which resulted in incorrect rendering as Gitbook doesn't allow double nesting detail sections.

A decision was made to lift these properties up into a separate group so that their nested Child Properties could be rendered correctly.

#623 separated them out from the main properties list. This PR shows them under ##Legacy Properties

Screenshots

https://docs.seam.co/latest/~/revisions/LRbIZnxkMUbMClEOdBo1/api/phones#legacy-properties

CleanShot.2025-06-14.at.13.19.51.mp4

@mikewuu mikewuu requested review from a team as code owners June 14, 2025 04:18
@mikewuu mikewuu requested a review from razor-x June 14, 2025 04:24
@@ -5,6 +5,9 @@
{{/if}}

- [Properties](./#properties)
{{#if legacyProperties}}
- [Legacy Properties](./#legacy-properties)
Copy link
Member

Choose a reason for hiding this comment

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

We don't actually want to call these Legacy yet in the docs :P Maybe device.properties?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmmmm. Nested Properties?

Copy link
Member

Choose a reason for hiding this comment

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

Just device.properties because every property is under device.properties.<property_name>

Alternatively we could prefix every property name in this section with properties, e.g., properties.online etc.

@debbie might have another idea but I'm happy with either of those options.

Copy link
Member

Choose a reason for hiding this comment

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

I like either of @razor-x's ideas here. The goal is for people to be able to come to this generated page and do a Ctrl-F if they want to look for a specific prop in the set of [top-level props + properties.x props].

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.

4 participants