-
Notifications
You must be signed in to change notification settings - Fork 19
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
Improvements for Documentation page #163
Labels
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In current docs page there are the new roles and sub-protocols introduced by SV2: if the roles can be well understood looking at homepage schemas, maybe the new sub-protocols are not very understandable without any schema.
For this reason I worked on a draft proposal, which restructures the layout of that page, inserting the schema present in the homepage, customized for every role and sub-protocol.
For example, this is the improvement which I thought for the Roles section:
![Screenshot 2023-03-10 at 22 35 09](https://user-images.githubusercontent.com/62447440/224432853-b150ade0-8841-49b6-86e7-4846961585f2.png)
NOTE: copy of Job Negotiators and Template Providers need to be reviewed, since I think that the words I put in red have to be deleted/changed in some way.
This is the improvement for the Sub-protocols section:
![Screenshot 2023-03-10 at 22 38 32](https://user-images.githubusercontent.com/62447440/224433329-7e320010-6b34-4a37-9d8b-bfb6565fc317.png)
NOTE: here I'd like to have opinions about the Job Distribution Protocol, since I don't know if it could be better to not mention it (in a first place) since it's not well described in specs.
Hope to get as more feedback as possible!
The text was updated successfully, but these errors were encountered: