-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add specification on top-nav #23
Conversation
✅ Deploy Preview for tufio ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that I'm seeing this, I think that we can rework (simplify) this. See inline comments.
1485a09
to
5765a46
Compare
This is ready for another review @chalin |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The text reads like a general TUF project overview, and only vaguely prepares the reader for the specification.
I suggest to remove it and just leave the index. Or add a small paragraph about what the user will find in the spec. Maybe you can take inspiration from this talk. More specifically, about how the spec defines a detailed client updater workflow and otherwise TUF repo primitives (roles, metadata, delegations), which can be used as building blocks.
@lukpueh Okay. I'll try. Thanks |
@lukpueh I have edited the section and added in the video you shared for reference. Let me know what you think. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lukpueh and I seem to have the same idea of having a single page (in fact, that is what I tried to convey in my round of comments from earlier).
Please make the changes suggested in the comments of this review.
Signed-off-by: sandra <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Signed-off-by: sandra <[email protected]>
Signed-off-by: sandra <[email protected]>
Signed-off-by: sandra <[email protected]>
Signed-off-by: sandra <[email protected]>
Signed-off-by: sandra <[email protected]>
Signed-off-by: sandra <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Signed-off-by: sandra <[email protected]>
03e5762
to
f497541
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There will be followup improvements to make (e.g., possibly not using type: docs
or maybe hiding the left nav, but that can be done later.
This PR covers issue #18
Moved specification on top-nav following a recommendation on the TUF documentation analysis
Please review @chalin @lukpueh