adobe / adobe/xdm

XDM Docs do not show require properties correctly

Open
#349 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
266
Forks
380
Avg merge
5d 8h
Merged PRs (30d)
9

Description

The documentation does not correctly say which properties are required.

Example:
https://github.com/adobe/xdm/blob/3ddccc36df572d61b014938e230226720bff1585/docs/reference/context/experienceevent.schema.md

There are required properties
"required": ["@id", "xdm:dataSource", "xdm:timestamp", "xdm:endUserIDs"]

Contributor guide

Open the contributing guide

Research direction

Open docs/reference/context/experienceevent.schema.md and compare its rendered documentation with the schema's required list: @id, xdm:dataSource, xdm:timestamp, and xdm:endUserIDs. Trace how the documentation is generated or presented, if indicated by the file, and confirm that these properties are visibly marked as required when the documentation is complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.