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

feat(doc): more info and arch diagram for landing page #822

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

timothymcmackin
Copy link
Collaborator

@timothymcmackin timothymcmackin commented Feb 14, 2025

Review landing page, add architecture page, and add arch diagram:

architecture

@timothymcmackin timothymcmackin self-assigned this Feb 14, 2025
Copy link

codecov bot commented Feb 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.52%. Comparing base (1576d38) to head (a4ac839).


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1576d38...a4ac839. Read the comment docs.

@johnyob
Copy link
Collaborator

johnyob commented Feb 19, 2025

There is a meta discussion here on whether we want to explain rollups to users? My opinion is that users of Jstz needn't know about rollups. So we could simplify the diagram to simply have Jstz with smart functions and Kv

@timothymcmackin timothymcmackin force-pushed the tpm/index-page-and-diagram branch from 499d1c5 to d11c29e Compare February 19, 2025 15:06
@timothymcmackin
Copy link
Collaborator Author

There is a meta discussion here on whether we want to explain rollups to users? My opinion is that users of Jstz needn't know about rollups. So we could simplify the diagram to simply have Jstz with smart functions and Kv

Part of the value proposition of Jstz is that it is secured by Tezos and is not just floating out there somewhere. I tried to simplify the explanation of what's going on -- how does this look, @johnyob ?

@johnyob
Copy link
Collaborator

johnyob commented Feb 26, 2025

Part of the value proposition of Jstz is that it is secured by Tezos and is not just floating out there somewhere. I tried to simplify the explanation of what's going on -- how does this look, @johnyob ?

Hey Tim 👋

We discussed this PR in our weekly meeting today. We believe explicitly linking Jstz to Tezos on the homepage of the documentation isn’t necessary, as most users don’t need to be aware of the underlying Tezos-specific architecture. Additionally, the current architecture diagram doesn’t align with the styling of Jstz’s documentation.

To move forward with this PR, we suggest:

  1. Placing explanations that reference Tezos-specific concepts (such as rollups) in an 'Advanced' section, ensuring they’re accessible only to users interested in Jstz’s implementation.
  2. Modifying the proposed diagram to match the styling of Jstz’s documentation.

@timothymcmackin
Copy link
Collaborator Author

Part of the value proposition of Jstz is that it is secured by Tezos and is not just floating out there somewhere. I tried to simplify the explanation of what's going on -- how does this look, @johnyob ?

Hey Tim 👋

We discussed this PR in our weekly meeting today. We believe explicitly linking Jstz to Tezos on the homepage of the documentation isn’t necessary, as most users don’t need to be aware of the underlying Tezos-specific architecture. Additionally, the current architecture diagram doesn’t align with the styling of Jstz’s documentation.

To move forward with this PR, we suggest:

1. Placing explanations that reference Tezos-specific concepts (such as rollups) in an 'Advanced' section, ensuring they’re accessible only to users interested in Jstz’s implementation.

2. Modifying the proposed diagram to match the styling of Jstz’s documentation.

Ok, I've moved the Tezos-specific stuff to an Architecture page and attempted to dark-mode the diagram. What do you think?

@timothymcmackin timothymcmackin force-pushed the tpm/index-page-and-diagram branch from d11c29e to a4ac839 Compare February 27, 2025 17:50
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.

2 participants