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

Add specification on top-nav #23

Merged
merged 13 commits into from
Aug 28, 2024
Merged

Add specification on top-nav #23

merged 13 commits into from
Aug 28, 2024

Conversation

Dindihub
Copy link
Owner

@Dindihub Dindihub commented Aug 24, 2024

This PR covers issue #18

Moved specification on top-nav following a recommendation on the TUF documentation analysis

Please review @chalin @lukpueh

Copy link

netlify bot commented Aug 24, 2024

Deploy Preview for tufio ready!

Name Link
🔨 Latest commit f497541
🔍 Latest deploy log https://app.netlify.com/sites/tufio/deploys/66cecc58c89c250008549518
😎 Deploy Preview https://deploy-preview-23--tufio.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Dindihub Dindihub requested review from lukpueh and chalin August 24, 2024 14:31
Copy link
Collaborator

@chalin chalin left a 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.

@Dindihub
Copy link
Owner Author

This is ready for another review @chalin

Copy link
Collaborator

@lukpueh lukpueh left a 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.

@Dindihub
Copy link
Owner Author

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

@Dindihub
Copy link
Owner Author

@lukpueh I have edited the section and added in the video you shared for reference. Let me know what you think.

@Dindihub Dindihub requested review from lukpueh and chalin August 27, 2024 10:58
Copy link
Collaborator

@chalin chalin left a 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.

Copy link
Collaborator

@chalin chalin left a 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.

@chalin chalin merged commit 4d71479 into main Aug 28, 2024
7 checks passed
@chalin chalin deleted the specification branch August 28, 2024 18:05
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

Successfully merging this pull request may close these issues.

3 participants