Skip to content

Conversation

@Simran-B
Copy link
Contributor

@Simran-B Simran-B commented Sep 11, 2025

Description

Simpler markup and shortcode implementation, with the added benefits that the expansion is natively handled by the browser and the in-page search opens the details automatically if the content contains a match.

  • Remove expand partial and use <details> element instead.
  • Combine CSS rules for .openapi-prop and generic <details> styling
  • Rename expand shortcode to details, and the title parameter to summary
  • Remove 4 second wait time from arangoproxy OpenAPI validation

Please check the following:

  • Program options with expandable details
  • OpenAPI properties that can be expanded (also nested)
  • The output of generated examples
  • Manual use of the expand (now details) shortcode, like the Predefined roles in ArangoGraph access control and the Batch HTTP API examples

They all worked fine in my test, and there are basically no visual oder behavioral changes.

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:
  • 3.13:

@Simran-B Simran-B requested a review from nerpaula September 11, 2025 18:01
@arangodb-docs-automation
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-786--docs-hugo.netlify.app

@Simran-B Simran-B self-assigned this Sep 11, 2025
@cla-bot cla-bot bot added the cla-signed label Sep 11, 2025
Copy link
Contributor

@nerpaula nerpaula left a comment

Choose a reason for hiding this comment

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

LGTM!

@Simran-B Simran-B merged commit 2ab47f2 into main Sep 12, 2025
5 checks passed
@Simran-B Simran-B deleted the simpler-expand branch September 12, 2025 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants