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

Proper documentation for alsoKnownAs #628

Open
evanp opened this issue Dec 6, 2024 · 3 comments
Open

Proper documentation for alsoKnownAs #628

evanp opened this issue Dec 6, 2024 · 3 comments
Labels
Next version Things that should probably be resolved in a next version of AS2

Comments

@evanp
Copy link
Collaborator

evanp commented Dec 6, 2024

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

@trwnh
Copy link

trwnh commented Dec 6, 2024

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

@evanp
Copy link
Collaborator Author

evanp commented Dec 13, 2024

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 evanp added the Next version Things that should probably be resolved in a next version of AS2 label Dec 13, 2024
@TallTed
Copy link
Member

TallTed commented Dec 18, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Next version Things that should probably be resolved in a next version of AS2
Projects
None yet
Development

No branches or pull requests

3 participants