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

Misc comments #8

Closed
lukpueh opened this issue Aug 2, 2024 · 2 comments · Fixed by #11
Closed

Misc comments #8

lukpueh opened this issue Aug 2, 2024 · 2 comments · Fixed by #11

Comments

@lukpueh
Copy link
Collaborator

lukpueh commented Aug 2, 2024

  • I like that the buttons and links on the landing page navigate to subpages inside docs. Maybe we can make this more consistent. That is, we map all buttons/links on the landing page to subpages . E.g. we could make "demo" and "friends" subpages in docs, to which "Try the demo" and "Explore integrations" point to. Those pages can then contain a short description of demo and friends repos and pointers to those repos. I think that might be a less disruptive experience, compared to when the user is directed to external pages right away on the landing page.

  • Why are there two search bars, one in the right top corner and one in the left navigation column? (no need to fix this now, I'm just curious)

  • Regarding content I am not sure if we should follow the recommendation from the cncf assessment and just re-publish the docs from python-in-toto as Getting started page. The documentation should represent the whole in-toto project, but the python-in-toto cli is only one of multiple in-toto implementations.

Originally posted by @lukpueh in #7 (comment)

@chalin
Copy link
Collaborator

chalin commented Aug 6, 2024

  • Why are there two search bars, one in the right top corner and one in the left navigation column? (no need to fix this now, I'm just curious)

@lukpueh - that's styling error in this repo. The search bar in the left nav should only appear when the top-nav search bar disappears -- on mobile or narrow displays. For an example of this behavior, see https://opentelemetry.io/docs/.

  • Regarding content I am not sure if we should follow the recommendation from the cncf assessment and just re-publish the docs from python-in-toto as Getting started page. The documentation should represent the whole in-toto project, but the python-in-toto cli is only one of multiple in-toto implementations.

Agreed.

@chalin
Copy link
Collaborator

chalin commented Aug 8, 2024

@lukpueh - that's styling error in this repo. The search bar in the left nav should only appear when the top-nav search bar disappears -- on mobile or narrow displays. For an example of this behavior, see https://opentelemetry.io/docs/.

Actually, I take that back, it seems to be the Docsy default styling. @DarikshaAnsari - see the OTel website repo styles to learn how to hide the sidenav search when the top-nav search is showing.

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 a pull request may close this issue.

2 participants