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: Restructure the documentation #278

Merged
merged 14 commits into from
Dec 6, 2024
Merged

feat: Restructure the documentation #278

merged 14 commits into from
Dec 6, 2024

Conversation

popzxc
Copy link
Member

@popzxc popzxc commented Nov 29, 2024

PR is in draft state: Some links are broken, highlight of active section in header is broken, redirects from old pages to new ones are not added.

The content, however, is in place and fully reviewable.


This PR restructures the ZKsync Era documentation.

Warning

No nitpick territory! Restructuring is highly subjective, and bikeshedding about big restructuring may introduce delays in getting this PR merged. Let's focus on critical issues here, and fix everything else in follow-up PRs.

New structure

I will not describe what moved where exactly. Instead, I invite reviewers to check the preview and try to find the information they care about. If it's hard to do and the place is not intuitive -- probably the restructuring doesn't work as intended.

However, here're some highlights:

  • Documentation is majorly restructured into three sections:
    • ZKsync Era: Everything about building on Era (or any other chain). Highly practical, focused on dApp developers.
    • ZK Stack: Everything about running your own stack. Again, focused on actions rather than on theory.
    • ZKsync Protocol: Theoretical information about the protocol.
  • SDK docs were embedded into the documentation instead of hosting them as another top-level category.

New content

I've tried to minimize the amount of new content, but in some places I felt that the sections are too incomplete (mostly in ZK Stack section). I've added a few new pages with minimum new information, just so that we close the gaps in the narrative. These are to be extended later.

Content added:

  • Changed the description of the sequencer in ZK Stack and added a link to the core book.
  • Changed the description of the prover in ZK Stack and added a link to the prover book.
  • Added a page about node framework.

Removed pages

Some of the pages have been removed. It mostly includes pages that either provide no information, pages that were copy-pasted from other pages, and pages that are not relevant for ZKsync (e.g. information available elsewhere).
Removed pages:

@popzxc
Copy link
Member Author

popzxc commented Nov 29, 2024

OK, it turns out that the preview cannot be deployed with broken links :harold:

@popzxc popzxc force-pushed the popzxc-docs-reorg branch 4 times, most recently from 3947b95 to 566e4dd Compare December 5, 2024 11:11
@popzxc popzxc force-pushed the popzxc-docs-reorg branch from 566e4dd to 2e67ab5 Compare December 5, 2024 11:39
Copy link

github-actions bot commented Dec 5, 2024

Visit the preview URL for this PR (updated for commit b01d096):

https://zksync-docs-staging-5eb09--pr278-popzxc-docs-reorg-1kbbudz0.web.app

(expires Fri, 13 Dec 2024 06:46:17 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bfaafba5fa82d4f63473aaa76a21fabf1fbb3a11

Copy link
Contributor

@hedgar2017 hedgar2017 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still want to keep Differences from L1 separately?
A lot of things there are describing EraVM, so we could merge the two sections.

@popzxc
Copy link
Member Author

popzxc commented Dec 5, 2024

Do we still want to keep Differences from L1 separately?

@hedgar2017 Yes, I think so. This section must be easily discoverable, so I want to have it as a top-level item.

@arose00
Copy link

arose00 commented Dec 6, 2024

Elliptic Curve Precompiles -- this is an overview of precompiles that are not yet available on ZKsync.

These precompiles are available. They are deployed as smart contracts though (were deployed during v24 IIRC).

The circuit based versions are not yet deployed.

@popzxc
Copy link
Member Author

popzxc commented Dec 6, 2024

These precompiles are available. They are deployed as smart contracts though (were deployed during v24 IIRC).

I see. Still, I'd argue that the contents do not match the spirit of docs, so it doesn't make much sense to keep them. What would work better is an overview of precompiles in general, but it's related to the content (so out of scope here)

@popzxc popzxc marked this pull request as ready for review December 6, 2024 11:35
@popzxc popzxc requested a review from a team as a code owner December 6, 2024 11:35
Copy link
Contributor

@Romsters Romsters left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, like the structure.

popzxc added a commit to zkSync-Community-Hub/community-code that referenced this pull request Dec 6, 2024
Aligns links in the header with
matter-labs/zksync-docs#278

This is done through a hack to avoid the need to change nuxt template,
publish new version, and then update the dep. We can do that as a
follow-up.
@popzxc popzxc merged commit 0ee9721 into main Dec 6, 2024
9 checks passed
@popzxc popzxc deleted the popzxc-docs-reorg branch December 6, 2024 13:56
Copy link

github-actions bot commented Dec 6, 2024

🎉 This PR is included in version 1.47.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@popzxc popzxc mentioned this pull request Dec 6, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants