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

Consider revising public-type-indexes and private-type-indexes #17

Open
csarven opened this issue Mar 28, 2023 · 0 comments
Open

Consider revising public-type-indexes and private-type-indexes #17

csarven opened this issue Mar 28, 2023 · 0 comments

Comments

@csarven
Copy link
Member

csarven commented Mar 28, 2023

Re #public-type-indexes and #private-type-indexes

The Public Type Index document contains registration entries
that are discoverable by outside users and applications.

"Outside"?

These registration entries are not necessarily accessible to all applications or
users.

I think this sentence is a bit out of place. Here the focus is on public. In the parent section where it introduces public/private that can be emphasised. Or simply leave this for private.

If something else was intended, paraphrase any way.

For example, suppose I have several address books - one that is
only for myself, one that is for a specific group of
colleagues, and one that is for the general public. The one
that is only for me, should be listed in the Private Type
Index. The other two, should be listed in the Public Type
Index. The fully public listing will point to a publicly
accessible resource while the one just for my colleagues
will point to a resource restricted by access control
methods. Both the public and restricted resources are
discoverable in the Public Type Index because an app that is
not operating as the WebID owner can not see the Private
Type Index.

If this is a quote, q or blockquote and cite it. Otherwise, consider expressing it along the lines of "suppose a user has" instead of first person.

This is useful info that should come before be part of the parent type-indexes section (before or after diagram) before diving into public-type-indexes and private-type-indexes sections.

Consider "cannot read the Private Type Index" (or "access") instead of "see" because the latter is unclear.


Consider not indenting <code> inside <pre> so that it doesn't move too far to the centre when the HTML is rendered in the browser. pre can be anywhere but start <code>s on new line, and then close </pre> right after last </code>.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant