Skip to content
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

Avoid nested <details> tags #538

Merged
merged 20 commits into from
Mar 28, 2025
Merged

Conversation

andrii-balitskyi
Copy link
Contributor

@andrii-balitskyi andrii-balitskyi commented Mar 20, 2025

Nested <details> tag doesn't seem to be rendered by gitbook.

<details>
<summary><code>acs_credential_on_seam.warnings</code> Format: <code>List</code> Item format: <code>Object</code></summary>
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
<details>
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
Date and time at which Seam created the warning.
</details>
<details>
<summary><code>message</code> Format: <code>String</code></summary>
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
</details>
<details>
<summary><code>warning_code</code> Format: <code>Enum</code></summary>
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Possible enum values:
- `waiting_to_be_issued`
- `schedule_externally_modified`
- `schedule_modified`
- `being_deleted`
- `unknown_issue_with_acs_credential`
- `needs_to_be_reissued`
</details>
</details>

https://docs.seam.co/latest/api/acs/encoders/scan_credential#acs_credential_on_seam.warnings-format-list-item-format-object
image

@andrii-balitskyi andrii-balitskyi requested a review from a team as a code owner March 20, 2025 13:51
@seambot seambot requested a review from a team as a code owner March 20, 2025 13:52
@andrii-balitskyi andrii-balitskyi changed the title Avoid nested details tags Avoid nested <details> tags Mar 20, 2025
@DebbieAtSeam
Copy link
Member

@andrii-balitskyi Should we make the nested props into a bulleted list so that it's a bit easier to see the breaks between them?

@andrii-balitskyi
Copy link
Contributor Author

andrii-balitskyi commented Mar 21, 2025

@andrii-balitskyi Should we make the nested props into a bulleted list so that it's a bit easier to see the breaks between them?

@DebbieAtSeam sounds good! I updated the code and here you can see the result: https://docs.seam.co/latest/~/revisions/d1XyxSDGaq8Ar231GVC9/api/acs/encoders/encode_credential#warnings-format-list-item-format-object.
Let me know what you think.

@DebbieAtSeam
Copy link
Member

DebbieAtSeam commented Mar 21, 2025

@andrii-balitskyi Should we make the nested props into a bulleted list so that it's a bit easier to see the breaks between them?

@DebbieAtSeam sounds good! I updated the code and here you can see the result: https://docs.seam.co/latest/~/revisions/d1XyxSDGaq8Ar231GVC9/api/acs/encoders/encode_credential#warnings-format-list-item-format-object. Let me know what you think.

Thanks, @andrii-balitskyi! Is there any way to get the descriptions, enum lists, etc. to align with the bullet content?
image

@andrii-balitskyi
Copy link
Contributor Author

andrii-balitskyi commented Mar 26, 2025

@DebbieAtSeam
Copy link
Member

@andrii-balitskyi andrii-balitskyi merged commit e51e6f6 into main Mar 28, 2025
13 checks passed
@andrii-balitskyi andrii-balitskyi deleted the avoid-nested-details-tags branch March 28, 2025 09:53
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