activitystreams icon indicating copy to clipboard operation
activitystreams copied to clipboard

Proper documentation for alsoKnownAs

Open evanp opened this issue 1 year ago • 3 comments

alsoKnownAs was added to the AS2 context in 2020. It's not documented in the spec. We should find a place to document it.

evanp avatar Dec 06 '24 18:12 evanp

We have https://www.w3.org/ns/activitystreams#did-core but it would probably make sense to put it in other documents as well

trwnh avatar Dec 06 '24 18:12 trwnh

I'm not sure what responsibility we have to document terms that are in our context document. I think that terms in our namespace, like alsoKnownAs, should probably be documented along with the other terms in our namespace. We do include other namespaces, and terms from other namespaces, in our context document, and I think it's perfectly fair to defer to those standards for documentation.

I'd suggest that for our next version of AS2, we document all the terms in the as: namespace, even if they are documented elsewhere.

evanp avatar Dec 13 '24 17:12 evanp

I know this is quibbling, but it's important that we who know the ins and outs of this stuff try to avoid shortcuts, so that people who are new to the space don't get the wrong impression from some of our shortcuts.

alsoKnownAs is not in any namespace. It's just a string.

as:alsoKnownAs is also not in any namespace. It requires that PREFIX ns: https://www.w3.org/ns/activitystreams# or similar precede it, to put it into the https://www.w3.org/ns/activitystreams namespace.

We should try to properly refer to it fully, as https://www.w3.org/ns/activitystreams#alsoKnownAs.

TallTed avatar Dec 18 '24 19:12 TallTed