Skip to content

Update Placeholder Notation Across Ant Media Server Documentation #559

Open
@amarantmeida

Description

@amarantmeida

Link to the documentation page or resource

https://antmedia.io/docs/guides/advanced-usage/webhooks/#available-webhooks

Describe the bug

This is a general documentation improvement request to standardize and clarify the use of placeholders (e.g., {streamId}, {category}, {metadata}) across all Ant Media Server documentation pages. Many users misinterpret these as literal values rather than dynamic variables to be replaced at runtime.

Additional context

No response

Suggested improvements or fixes

To improve clarity and reduce support queries, we need to:

  1. Ensure all placeholders are clearly marked using {} brackets.
  2. Add a brief note near the first occurrence explaining that these are placeholders to be replaced with actual values by the user or server.
  3. Review and update all relevant sections, including webhook payloads, API examples, and configuration instructions.

This update should be applied consistently across the entire documentation site to improve usability and developer experience.

Related issue(s)/PR(s)

No response

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions