-
Notifications
You must be signed in to change notification settings - Fork 27
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
Release #108
Release #108
Commits on Mar 15, 2024
-
chore: setups up repository (#3)
Changes introduced in this PR: - Adds templates and codeowners - Inits bun project - Sets up initial "checks". @itsacoyote I just defaulted to these, we can change accordingly to our preference as the project evolves.
Configuration menu - View commit details
-
Copy full SHA for 15f5bfb - Browse repository at this point
Copy the full SHA 15f5bfbView commit details
Commits on Mar 18, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 1ee722a - Browse repository at this point
Copy the full SHA 1ee722aView commit details -
Configuration menu - View commit details
-
Copy full SHA for df2c9cc - Browse repository at this point
Copy the full SHA df2c9ccView commit details
Commits on Mar 19, 2024
-
# What 💻 * Setup Nuxt Content project with a starter template that includes Nuxt, Nuxt Content, Nuxt UI Pro, Nuxt Studio. * Modified setting configs for variety of things. Prettier, ESLint, MarkdownLint, Spellcheck, etc. * Threw in all the existing markdown documentation from existing site into `/content/`. Will figure out cleanup and organization in the process. # Why ✋ * Need a new framework to develop in * Need to mess with existing docs and how it'll integrate into the new framework # Notes 📝 README is not up to date for managing and running the project yet. There's a bunch of junk also that may make no sense, but was just caught up in the commit when testing out the framework. To get started, install then run `bun run dev -o` --------- Co-authored-by: Dustin Brickwood <dustinbrickwood204@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for c10d086 - Browse repository at this point
Copy the full SHA c10d086View commit details
Commits on Mar 21, 2024
-
feat: build out a basic theme and landing page (#5)
# What 💻 * first pass at landing page design * updated theme colors to better match zksync # Why ✋ * needs to look zksync branded * have a decent starting point for a landing page to start from # Evidence 📷 run project locally to see cool stuff.
Configuration menu - View commit details
-
Copy full SHA for 118d954 - Browse repository at this point
Copy the full SHA 118d954View commit details
Commits on Mar 26, 2024
-
feat: adds deployment pipeline for preview / staging / prod & address…
…es lint issues (#6) # What 💻 * Adds preview / staging / deployment actions for firebase * Runs eslint and corrections * Updates checks.yaml file # Why ✋ * For setting up initial deployment environments * Clean code is good * Adds eslint to checker # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended ![Screenshot 2024-03-25 at 9 26 48 AM](https://github.com/matter-labs/zksync-docs/assets/29983536/b7886245-de14-4f8e-b63a-5f6323803ef7) <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for df27edd - Browse repository at this point
Copy the full SHA df27eddView commit details
Commits on Mar 27, 2024
-
# What 💻 * Adjusted the particles configuration * cleaned up some things missed when testing nuxt content * adjusted prettier ignore # Why ✋ * cleaner templates and particles configuration is now in a separate file * components made for Nuxt Content need to be placed in `/components/content/` folder. This accidentally got covered by the prettier ignore file. The purpose of the prettier ignore for markdown content is so that we don't have prettier formatting non-standard markdown content (like vue component syntax) and breaking them. This is why markdown is ignored for now on prettier auto formatting.
Configuration menu - View commit details
-
Copy full SHA for d3206fc - Browse repository at this point
Copy the full SHA d3206fcView commit details
Commits on Apr 1, 2024
-
feat: create code switcher tab (#8)
# What 💻 * Create a component that tabs content for display * Create a component that displays partial markdown files for re-use across documents # Why ✋ * Breaks down complex instructions that will be hidden in tabs into partials for easier editing. * Makes it easier to re-use content versus re-writing content. # Evidence 📷 ![Screenshot 2024-03-27 at 3 21 48 PM](https://github.com/matter-labs/zksync-docs/assets/812331/2ff1eb91-fa1f-4231-82de-51f61dd51702) Example set up in the Getting Started page to show how it can be used. NuxtUI has a UTabs component that can be used plainly if we didn't want to use this. This new component provides a way to have tabbed content that can be loaded from partial markdown files to help split up content and make editing potentially easier. A future feature to implement in this component would be to have a way to track which tab is actively selected and update similar tabs to the same selected tab. Also store this selected tab in localStorage potentially so that the preferred tab for the user is always selected across the site.
Configuration menu - View commit details
-
Copy full SHA for a16e1b4 - Browse repository at this point
Copy the full SHA a16e1b4View commit details
Commits on Apr 4, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 9e322a0 - Browse repository at this point
Copy the full SHA 9e322a0View commit details
Commits on Apr 9, 2024
-
feat: create documentation guideline articles (#11)
# What 💻 * Created a collection of articles on Documentation Contribution Guidelines * Contributing * Contribution Guidelines * Documentation Styleguide * Created a Resources section * Glossary # Why ✋ * Create a set of standards to help with consistency across our documentation.
Configuration menu - View commit details
-
Copy full SHA for ef82423 - Browse repository at this point
Copy the full SHA ef82423View commit details
Commits on Apr 11, 2024
-
feat: create parser for zksync info (#12)
# What 💻 * Create a parser that replaces tags in markdown content with values defined in a _zksync.json file. # Why ✋ * For very important content, we don't want to copy/past and rewrite things all over the docs. # How it works Content is structured in a json file under `content/_zksync.json`. Tags are wrapped in `%%` and are prefixed with `zk_`. The path to the value in the json file is represented with underscores instead of a dot. Let's say we want to put the Mainnet block explorer URL into a page somewhere. It's in the JSON file as `mainnet.block_explorer_url`. The tag for it will be `%%zk_mainnet_block_explorer_url%%`.
Configuration menu - View commit details
-
Copy full SHA for be2c6a9 - Browse repository at this point
Copy the full SHA be2c6a9View commit details -
Configuration menu - View commit details
-
Copy full SHA for 2640353 - Browse repository at this point
Copy the full SHA 2640353View commit details
Commits on Apr 12, 2024
-
feat: add zksync-cli docs (#13)
# What 💻 * update the docs with Block Explorer page * condensed the block explorers pages into one * Update the docs with tooling/zksync-cli docs * Reformatted the content * Shifted the API Reference docs in the navigation * Removed `noreferrer` from external link component. * primarily for analytics purposes. I don't think it hurts to remove it, and makes it easier to track incoming for analytics. * Added vscode snippets file for reusable snippets. # Why ✋ * Easier to read and navigate zksync-cli commands via the navigation
Configuration menu - View commit details
-
Copy full SHA for ab7b5ab - Browse repository at this point
Copy the full SHA ab7b5abView commit details
Commits on Apr 15, 2024
-
feat: initial quickcode guide for deploying contract using hardhat or…
… foundry (#10) # What 💻 * Adds initial quickstart guide framework * Adds components for organizing content * Adds reusable content in partials # Why ✋ * Includes quickstart for deploying, factories, testing, upgrading, and general paymaster flow * Components are helpful for displaying and organizing content # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? --> --------- Co-authored-by: Sabrina Ferguson <sf@matterlabs.dev>
Configuration menu - View commit details
-
Copy full SHA for 89e025e - Browse repository at this point
Copy the full SHA 89e025eView commit details
Commits on Apr 16, 2024
-
feat: add tooling docs for hardhat and foundry (#15)
# What 💻 * Add doc sections for Hardhat and Foundry
Configuration menu - View commit details
-
Copy full SHA for c583f87 - Browse repository at this point
Copy the full SHA c583f87View commit details -
feat: update to include approval flow for paymaster onboarding (#17)
# What 💻 * Adds approval paymaster flow guide * Makes small edits / fixes # Why ✋ * Distinction between approval flow and general flow paymasters # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for c3ee8b9 - Browse repository at this point
Copy the full SHA c3ee8b9View commit details
Commits on Apr 18, 2024
-
chore: improve foundry-zksync installation (#18)
# What 💻 * Simplified foundry-zksync installation and makes use of pre-compiled binaries instead of source # Why ✋ * Better experience # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 213fd8f - Browse repository at this point
Copy the full SHA 213fd8fView commit details -
# What 💻 * Add test and debug section to docs
Configuration menu - View commit details
-
Copy full SHA for 44b0d41 - Browse repository at this point
Copy the full SHA 44b0d41View commit details -
# What 💻 * Adds navigation for Build, ZK Stack and External Node * Moves /content directory around to match site navigation structure # Why ✋ * Need to add in the other sections of the docs website
Configuration menu - View commit details
-
Copy full SHA for fe62748 - Browse repository at this point
Copy the full SHA fe62748View commit details
Commits on Apr 22, 2024
-
chore: add zk-stack/concepts pages (#20)
# What 💻 * Add the zk-stack concepts section to the docs * Add Katex for math equation rendering * The zksync Fee Mechanism page renders math equations.
Configuration menu - View commit details
-
Copy full SHA for 8fc911c - Browse repository at this point
Copy the full SHA 8fc911cView commit details -
# What 💻 * Add zk-stack components section to docs
Configuration menu - View commit details
-
Copy full SHA for bab50c6 - Browse repository at this point
Copy the full SHA bab50c6View commit details -
chore: add external-node docs (#22)
# What 💻 * Add External Node section to docs
Configuration menu - View commit details
-
Copy full SHA for 2fcfeb1 - Browse repository at this point
Copy the full SHA 2fcfeb1View commit details
Commits on Apr 23, 2024
-
# What 💻 * update font for readability * Use fira mono for code font
Configuration menu - View commit details
-
Copy full SHA for 3790c0c - Browse repository at this point
Copy the full SHA 3790c0cView commit details -
chore: use ProseA for all links (#24)
# What 💻 * Switch all links to use standard markdown format for links - `[some text](url)` * Update the ProseA component that edits markdown links * external links have added rel tags and an icon to indicate opening in a new tab. * remove the ExternalLink component # Why ✋ * Recently learned that we can override Prose components which NuxtContent provides. This allows us to customize particular Prose components like the Anchor tag component to further customize how it renders links. * This will help us to consistently use a single syntax for links and still handle external link formatting. ### Cool Factoid Did you know you can do some fancy replace with VSCode search? Rather than tediously manually replacing all external-link references with the markdown syntax, you can use regex to search then "select" text from the results to use in a replace action. `:external-link\{text="([^"]*)" href="([^"]*)"\}` The `( )` groups text as a value that you can reference with `$#` in the replace: `[$1]($2)`
Configuration menu - View commit details
-
Copy full SHA for ddc8f8e - Browse repository at this point
Copy the full SHA ddc8f8eView commit details -
feat: use sol and vyper logos for code (#25)
# What 💻 * Added two custom logos for Remix IDE and AtlasZK IDE. * Added additional icon libraries to support displaying logos for Solidity and Vyper # Why ✋ * Sol and Vyper logos can display on the code preview components
Configuration menu - View commit details
-
Copy full SHA for 8675ea0 - Browse repository at this point
Copy the full SHA 8675ea0View commit details -
chore: add link check to GH action (#26)
# What 💻 * Add a github action to check links for 404s * This *only* checks internal links # Why ✋ * Ensure we don't provide links to broken pages
Configuration menu - View commit details
-
Copy full SHA for 4c94b3d - Browse repository at this point
Copy the full SHA 4c94b3dView commit details
Commits on Apr 24, 2024
-
feat: add nuxt image module (#27)
# What 💻 * Install the Nuxt Image module # Why ✋ * Optimizes images # Notes 📝 * Nuxt Content just added NuxtImage support in their `ProseImg` component literally hours ago. This means that it is not available yet in an official release. In the meantime, I just copied the code from the PR and we can remove our `ProseImg` component when the latest release includes it.
Configuration menu - View commit details
-
Copy full SHA for 18fee59 - Browse repository at this point
Copy the full SHA 18fee59View commit details
Commits on Apr 25, 2024
-
chore: remove unneeded step (#30)
# What 💻 * Not needed step as per devops review # Why ✋ * Not needed here # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 0289f4f - Browse repository at this point
Copy the full SHA 0289f4fView commit details -
feat: add ecosystem pages (#29)
# What 💻 * Adds ecosystem section # Why ✋ * Showcase ecosystem services # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 8af0006 - Browse repository at this point
Copy the full SHA 8af0006View commit details
Commits on Apr 29, 2024
-
add cookbook link for preview (#32)
- add cookbook link to top header nav for previewing
Configuration menu - View commit details
-
Copy full SHA for 89cf4c3 - Browse repository at this point
Copy the full SHA 89cf4c3View commit details -
# What 💻 * 101 content and images * networkAdder component * Uses global variable for testnet across the docs # Why ✋ * New content # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 07290fe - Browse repository at this point
Copy the full SHA 07290feView commit details -
feat: Link directly to doc semantic framework (#37)
This was unclear if not already familiar with the framework and avoids conflating this with eastern orthodoxy liturgy # What 💻 * Replace the text Diataxis with a link to the diataxis page in the header section * Replace the text Diataxis with a link to the diataxis page in the category section # Why ✋ * I hadn't heard of this framework before *Searching for this text brings up some conflicting results depending on what site you trust # Evidence 📷 From here: https://zksync-docs-staging-5eb09--pr37-cbe-devrl-527-link-t-lxa3l56t.web.app/build/contributing-to-documentation/documentation-styleguide ![image](https://github.com/matter-labs/zksync-docs/assets/2054226/cbe538db-50fc-4dd1-9dd1-8c6c2ade04c9)
Configuration menu - View commit details
-
Copy full SHA for 70a91e2 - Browse repository at this point
Copy the full SHA 70a91e2View commit details
Commits on May 1, 2024
-
# What 💻 - new branch of #40 replaced zkSync with ZKsync # Why ✋ Branding change # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? --> --------- Co-authored-by: bxpana <42230936+bxpana@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 8519129 - Browse repository at this point
Copy the full SHA 8519129View commit details
Commits on May 2, 2024
-
feat: Add more code blocks for yarn (#45)
This adds code blocks to places where there was only yarn before so at least there is npm and adds bun to other places where only yarn and npm were before. This does not cover everything, but catches some obvious places # What 💻 * Added code blocks to areas that just had yarn hard-coded * In code blocks that only had yarn and npm, add bun # Why ✋ * Having just yarn is inconsistent * Other places have bun # Evidence 📷 ![image](https://github.com/matter-labs/zksync-docs/assets/2054226/f38861cd-98fc-4e57-92f1-6f6100620c7e) # Notes 📝 * There isn't exhaustive for all locations that do this multi-command option, so there are options for follow ups * Adding a parameterized partial that auto-translates an npm command to the yarn and bun commands might be cool (https://www.npmjs.com/package/npm-to-yarn, but then needs something for bun)
Configuration menu - View commit details
-
Copy full SHA for 4337d07 - Browse repository at this point
Copy the full SHA 4337d07View commit details
Commits on May 6, 2024
-
feat: add check on zk parser (#28)
# What 💻 * Add a console error if a zk tag is unparsed because of bad formatting # Why ✋ * Avoid displaying any unformatted/broken tags in production # Evidence 📷 ![Screenshot 2024-04-23 at 3 46 14 PM](https://github.com/matter-labs/zksync-docs/assets/812331/48e35a1c-470d-43d9-9bbc-4d8c15efed65) # NOTE This does not stop a build process from happening. The parser runs on dev and if an error is Thrown it causes all sorts of hiccups on the local server to restart smoothly. For now this is just a console log for the developer to notice. May sit on this and think of a way to throw an error only on build later on.
Configuration menu - View commit details
-
Copy full SHA for f472a65 - Browse repository at this point
Copy the full SHA f472a65View commit details -
Itsacoyote devrl 508 prosea styling of arrow icon (#33)
# What 💻 * Fix icon styling for external links # Why ✋ * Absolute positioning was placing the arrow icon in a bad spot when text wraps around to a new line.
Configuration menu - View commit details
-
Copy full SHA for 0301283 - Browse repository at this point
Copy the full SHA 0301283View commit details -
# What 💻 * Links for "Edit this page" and "Share feedback" in the sidebar under the TOC were broken # Why ✋ * reference vue props were incorrect
Configuration menu - View commit details
-
Copy full SHA for 6d32fbc - Browse repository at this point
Copy the full SHA 6d32fbcView commit details -
feat: uses zksync-cli for quickstart templates (#31)
Leaving as a DRAFT until the following PRs are merged: - matter-labs/zksync-cli#132 - matter-labs/zksync-contract-templates#11 # What 💻 * Uses zksync-cli for quickstart bootstrapping # Why ✋ * Easiest way to get started # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for c1a9a70 - Browse repository at this point
Copy the full SHA c1a9a70View commit details
Commits on May 7, 2024
-
feat: add Build landing page (#50)
# What 💻 * Create a landing page for Build section that provides an overview and links to the 101 and quickstart guides. * Moved the content from the ZKsync 101 intro into the Build Introduction page since it works really well for the landing page. * Added a couple additional entries to the glossary * Moved the Connect to ZKsync from ZKsync 101 to a top level navigation just under the new Build landing page. * The reasoning behind this is that it provides all the information on connecting a user's wallet to the ZKsync network which should be valid for everything and not just inside ZKsync 101 section. * This makes the link for someone to add the network to their wallet extremely quick to find. # Why ✋ * Provide a starting landing page that helps guide the reader to resources they might need at a quick glance.
Configuration menu - View commit details
-
Copy full SHA for 6ea412a - Browse repository at this point
Copy the full SHA 6ea412aView commit details
Commits on May 8, 2024
-
feat: add image lightbox and image styleguide rules (#51)
# What 💻 * Add image lightbox feature for images * Add rules to contribution styleguide for images * Add lazy loading for images # Why ✋ * Allows for expanding images for easier viewing * Optimize loading of images
Configuration menu - View commit details
-
Copy full SHA for f759aae - Browse repository at this point
Copy the full SHA f759aaeView commit details
Commits on May 9, 2024
-
fix: notes from feedback session (#52)
# What 💻 * fix broken links * adds missing links * rephrases to simplify # Why ✋ * Feedback from offsite session # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 43a0cc5 - Browse repository at this point
Copy the full SHA 43a0cc5View commit details -
feat: add dev reference for build section (#41)
# What 💻 * adds developer reference to build section # Why ✋ * Need it # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for d61c6c5 - Browse repository at this point
Copy the full SHA d61c6c5View commit details -
fix: address feedback bugs (#53)
# What 💻 * Fixes the posted bugs: - https://linear.app/matterlabs/issue/DEVRL-512/[hello-zksync-page]-incorrect-link-contracts-directory-leads-to-404 - https://linear.app/matterlabs/issue/DEVRL-515/[hello-zksync-page]-deploy-the-contract-block-incorrect-link - https://linear.app/matterlabs/issue/DEVRL-531/add-information-about-crown-token-claim # Why ✋ * Improves the docs # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 8df20c4 - Browse repository at this point
Copy the full SHA 8df20c4View commit details -
chore: update name from Cookbook to Community Code (#54)
# What 💻 * Changes name from Cookbook to Community Code # Why ✋ * New name is more fitting # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 41fcf0f - Browse repository at this point
Copy the full SHA 41fcf0fView commit details -
# What 💻 * First thing updated with this PR * Second thing updated with this PR * Third thing updated with this PR # Why ✋ * Reason why first thing was added to PR * Reason why second thing was added to PR * Reason why third thing was added to PR # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 562e29b - Browse repository at this point
Copy the full SHA 562e29bView commit details -
chore: add sdk docs to nav (#55)
Related to: zksync-sdk/sdk-docs#7 # What 💻 * Adds SDK docs to top nav # Why ✋ * So devs can use SDKs # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for dbf9f2c - Browse repository at this point
Copy the full SHA dbf9f2cView commit details -
# What 💻 - Fix #35 # Why ✋ * Adds info about signed commits # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? --> --------- Co-authored-by: Sabrina Ferguson <sf@matterlabs.dev>
Configuration menu - View commit details
-
Copy full SHA for 7fe1c58 - Browse repository at this point
Copy the full SHA 7fe1c58View commit details
Commits on May 10, 2024
-
# What 💻 * Fixed a couple of minor issues reported by QA team Artem. # Why ✋ * Without those users would click on missing links, run into issues when running a particular command, etc. --------- Co-authored-by: Sabrina Ferguson <sf@matterlabs.dev>
Configuration menu - View commit details
-
Copy full SHA for 392dcae - Browse repository at this point
Copy the full SHA 392dcaeView commit details
Commits on May 13, 2024
-
Switch to zksync docs nuxt template (#60)
# What 💻 * Use the zksync docs nuxt template in the docs project # Why ✋ * This will help with the consistency of theming and reusable components to be shared across projects.
Configuration menu - View commit details
-
Copy full SHA for 3192f8c - Browse repository at this point
Copy the full SHA 3192f8cView commit details
Commits on May 14, 2024
-
feat: adds community docs back and best practices (#58)
# What 💻 * Adds community docs back and best practices * removes outdates oracle # Why ✋ * Important info to keep * does not exist anymore # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 57399f1 - Browse repository at this point
Copy the full SHA 57399f1View commit details -
feat: adds markdown link checker to CI (#59)
# What 💻 * Moves linkchecker from preview job to checks jobs # Why ✋ * Follows the checks workflow more then site building and deployment job # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 897f371 - Browse repository at this point
Copy the full SHA 897f371View commit details
Commits on May 16, 2024
-
chore: update foundry qs qith zksync-cli usage (#61)
Related PR: matter-labs/zksync-cli#135 - [x] Still need to make a zksync-cli release. # What 💻 * Updates foundry quickstart to use zksync-cli for bootstrapping project * Fixes linking # Why ✋ * Quickest way to get started * Paths had changed # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 8985d50 - Browse repository at this point
Copy the full SHA 8985d50View commit details -
# What 💻 * Closes bug reports: - [x] https://linear.app/matterlabs/issue/DEVRL-593/[ecosystem]-nft-marketplaces-page-zonic-item-need-to-be-removed-since - [x] https://linear.app/matterlabs/issue/DEVRL-594/[tooling]-hardhat-zksync-node-page-empty-learn-more-block-present - [x] https://linear.app/matterlabs/issue/DEVRL-609/missing-zks-getl1batchblockrange - [x] https://linear.app/matterlabs/issue/DEVRL-577/[tooling]-block-explorers-page-incorrect-links-fpr-be-api - [x] https://linear.app/matterlabs/issue/DEVRL-602/2-different-formats-for-code-blocks-available-for-docs # Why ✋ * Bugs are bad # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for be20471 - Browse repository at this point
Copy the full SHA be20471View commit details -
fix: update docs to latest from existing, update ZKsync to zkSync (#63)
# What 💻 * update docs to latest from existing * update ZKsync to zkSync # Why ✋ * Need latest info * Name change has not happened # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? --> --------- Co-authored-by: Sabrina Ferguson <sf@matterlabs.dev>
Configuration menu - View commit details
-
Copy full SHA for 5fd8689 - Browse repository at this point
Copy the full SHA 5fd8689View commit details -
fix: aligned external links format (#65)
# What 💻 * aligned external links format to remove `link_link` URLs * fixed 404 link for Pyth # Why ✋ * Reason why first thing was added to PR * Reason why second thing was added to PR * Reason why third thing was added to PR # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 4b42f8b - Browse repository at this point
Copy the full SHA 4b42f8bView commit details -
chore: update docs with latest upstream PR (#67)
- update docs to latest
Configuration menu - View commit details
-
Copy full SHA for 1b2334d - Browse repository at this point
Copy the full SHA 1b2334dView commit details -
# What 💻 * update theme # Why ✋ * latest changes in docs template repo need to be applied.
Configuration menu - View commit details
-
Copy full SHA for dce9eba - Browse repository at this point
Copy the full SHA dce9ebaView commit details -
fix: address todos - part 1 (#66)
# What 💻 * Address series of todos # Why ✋ * Need to get done # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? --> --------- Co-authored-by: Sabrina Ferguson <sf@matterlabs.dev>
Configuration menu - View commit details
-
Copy full SHA for 021337a - Browse repository at this point
Copy the full SHA 021337aView commit details -
fix: update commands for quickstart (#68)
# What 💻 * Updates commands for qs # Why ✋ * Fixes execution # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for d434943 - Browse repository at this point
Copy the full SHA d434943View commit details
Commits on May 17, 2024
-
# What 💻 * Fix broken links to old docs * More detailed steps in "Deploy first contract" * Adds missing step in "Connect to zkSync" * Typos # Why ✋ * Fixing QA review * Fixes DEVRL-533, DEVRL-534, DEVRL-540, DEVRL-542 # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 4406f7c - Browse repository at this point
Copy the full SHA 4406f7cView commit details -
fix: changed incorrect symbol (#72)
# What 💻 * Fixed incorrect dash in the foundry command # Why ✋ * Reason why first thing was added to PR * Reason why second thing was added to PR * Reason why third thing was added to PR # Evidence 📷 ![image](https://github.com/matter-labs/zksync-docs/assets/112873874/272886d1-bbac-4899-86eb-626dc897cde5) <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 23bc172 - Browse repository at this point
Copy the full SHA 23bc172View commit details -
chore: update proj structure for zksync 101 and qs (#73)
# What 💻 * update proj structure for zksync 101 and qs # Why ✋ * Makes sense # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for d68785a - Browse repository at this point
Copy the full SHA d68785aView commit details -
ci: add release workflow and enforce conventional commits (#69)
# What 💻 * add release workflow * enforce conventional commits, Closes #36 # Why ✋ * Prepares for prod env * Maintainability # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 28700ee - Browse repository at this point
Copy the full SHA 28700eeView commit details -
chore: update readme with fixed links and some sparkle (#75)
# What 💻 * Fix contribution links * Add sparkle # Why ✋ * Links were broken * Sparkle is cool # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for d5c014d - Browse repository at this point
Copy the full SHA d5c014dView commit details -
# What 💻 * Fix broken commands * Second thing updated with this PR * Third thing updated with this PR # Why ✋ * Reason why first thing was added to PR * Reason why second thing was added to PR * Reason why third thing was added to PR # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 0a395fe - Browse repository at this point
Copy the full SHA 0a395feView commit details
Commits on May 20, 2024
-
# What 💻 * Fix small cmd error # Why ✋ * Fixes issue # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 9a0c0c8 - Browse repository at this point
Copy the full SHA 9a0c0c8View commit details -
fix: moved repos to community org (#79)
# What 💻 * Moved tutorial repos from personal account to community org # Why ✋ * DEVRL-619 # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for f367a05 - Browse repository at this point
Copy the full SHA f367a05View commit details
Commits on May 21, 2024
-
feat: add sdk docs as part of build (#80)
# What 💻 * Add sdk as part of the docs build # Why ✋ * Currently sdk repo cannot deploy to a separate host as we don't have the means to set up a reverse proxy to handle `/sdk`. * This includes the sdk build into docs so that it all goes out in one deploy.
Configuration menu - View commit details
-
Copy full SHA for 2acfb7c - Browse repository at this point
Copy the full SHA 2acfb7cView commit details
Commits on May 22, 2024
-
Configuration menu - View commit details
-
Copy full SHA for aeb3869 - Browse repository at this point
Copy the full SHA aeb3869View commit details
Commits on May 23, 2024
-
Resolves DEVRL-690, DEVRL-691, DEVRL-627, DEVRL-649, DEVRL-692 - https://linear.app/matterlabs/issue/DEVRL-692/fix-improperly-formatted-links - https://linear.app/matterlabs/issue/DEVRL-649/small-ify-buttons - https://linear.app/matterlabs/issue/DEVRL-627/change-url-for-dev-updates-card - https://linear.app/matterlabs/issue/DEVRL-691/remove-a-link-to-zksync-erareleases-see-whats-new-in-2420-from-docs - https://linear.app/matterlabs/issue/DEVRL-690/move-cards-on-build-to-bottom-of-the-page ## List of changes - added links to breadcrumbs - added redirects for certain paths that don't have an index page - fixed links that were improperly formatted for Nuxt Content - adjusted some buttons that were too large - update Dev Updates card on landing page to point to zksyncDevs twitter account - remove the version update link in the hero section of the landing page - moved cards on the Build index page down to the bottom of the page
Configuration menu - View commit details
-
Copy full SHA for 606e617 - Browse repository at this point
Copy the full SHA 606e617View commit details -
Update description wording Tested out the "Edit this page" link from the staging website, works pretty easily and allows for creating a "patch" branch to create the PR.
Configuration menu - View commit details
-
Copy full SHA for 1955cc4 - Browse repository at this point
Copy the full SHA 1955cc4View commit details -
Resolves DEVRL-697 https://linear.app/matterlabs/issue/DEVRL-697/add-analytics-to-zksync-docs ## List of changes - Add Google Analytics - Analytics is disabled for non-production environments
Configuration menu - View commit details
-
Copy full SHA for e742ea5 - Browse repository at this point
Copy the full SHA e742ea5View commit details
Commits on May 24, 2024
-
- Add husky hooks for pre-commit - Add staged-lint for pre-commit to check staged files - Edit workflows - Adjust use of Bun - Configure workflow actions, testing release with a dry-run, ensure build actions work
Configuration menu - View commit details
-
Copy full SHA for a3976c8 - Browse repository at this point
Copy the full SHA a3976c8View commit details
Commits on May 28, 2024
-
Updates to use Foundry keystore (#84)
# What 💻 * Updates 101 getting started to setup a keystore * Updates all 101 Foundry tutorials to use keystore in commands to deploy/send txs * Update all commands in Foundry guide with examples of keystore use and PK. * Additionally, fixes a partial not correctly displayed in paymaster page # Why ✋ * Fixes DEVRL676 * To be merged with matter-labs/zksync-contract-templates#14 # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? --> --------- Co-authored-by: Nicolas Villanueva <nicolasvillanueva@msn.com>
Configuration menu - View commit details
-
Copy full SHA for ebf8b50 - Browse repository at this point
Copy the full SHA ebf8b50View commit details -
fix: updated verify commands (#88)
# What 💻 * updated verify commands for npm and pnpm (UUPS) to align with Beacon and Transparent proxy tutorials - current `npm run hardhat verify <PROXY-ADDRESS>` fails # Why ✋ * Reason why first thing was added to PR * Reason why second thing was added to PR * Reason why third thing was added to PR # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <img width="937" alt="image" src="https://github.com/matter-labs/zksync-docs/assets/112873874/5c7b917a-d117-42c5-913a-f35f6c2702f0"> <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for f5d4c8f - Browse repository at this point
Copy the full SHA f5d4c8fView commit details
Commits on May 29, 2024
-
chore(ci): disable husky in workflows (#93)
Disable husky in github workflows
Configuration menu - View commit details
-
Copy full SHA for 80a4472 - Browse repository at this point
Copy the full SHA 80a4472View commit details -
chore(docs): update reference to bridge in Sepolia faucets (#91)
Resolves DEVRL-686 Update the bridge referenced in the Sepolia faucets to the zksync bridge.
Configuration menu - View commit details
-
Copy full SHA for 4e43c13 - Browse repository at this point
Copy the full SHA 4e43c13View commit details -
Updates docs to be up to date with latest from current docs
Configuration menu - View commit details
-
Copy full SHA for 7063e7b - Browse repository at this point
Copy the full SHA 7063e7bView commit details
Commits on May 30, 2024
-
# What 💻 * Adds warning for installing deps with NPM # Why ✋ * NPM unable to properly resolve deps. * Fix DEVRL-702 and DEVRL-622 # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 854011b - Browse repository at this point
Copy the full SHA 854011bView commit details
Commits on May 31, 2024
-
chore: fix lint-staged command (#96)
Fix the lint-staged command for cspell. It was missing an additional part of the command to check files individually via lint-staged.
Configuration menu - View commit details
-
Copy full SHA for d3e5944 - Browse repository at this point
Copy the full SHA d3e5944View commit details -
Replacing pnpx command with pnpm (#98)
# What 💻 * Replacing pnpx command with pnpm (pnpx is deprecated) # Why ✋ * Pnpx command cause errors # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended <!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. --> <!-- # Notes 📝 * Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
Configuration menu - View commit details
-
Copy full SHA for 98a1ceb - Browse repository at this point
Copy the full SHA 98a1cebView commit details
Commits on Jun 3, 2024
-
docs: fix formatting errors (#94)
- Fixes syntax of callouts defined in docs. - Remove links from headers and place them in the body content.
Configuration menu - View commit details
-
Copy full SHA for f00f952 - Browse repository at this point
Copy the full SHA f00f952View commit details -
chore(docs): update content for legal (#90)
Resolves DEVRL-704, DEVRL-708, DEVRL-709, DEVRL-711 - Made edits to the description of the Paymaster in quickstart and zksync 101. - Added disclaimers to paymaster page for quickstart and zksync 101. - Added a Paymaster entry to the Glossary. - Added a disclaimer to the ERC20 page for quickstart.
Configuration menu - View commit details
-
Copy full SHA for 1bca15a - Browse repository at this point
Copy the full SHA 1bca15aView commit details -
chore: update project docs (#97)
- Adds a collection of markdown documents to add to our [Community Standards](https://github.com/matter-labs/zksync-docs/community). - Code of Conduct doc - Contributing doc for getting started - Add cute little tags to the README - Add a Support doc to help users in getting support - Adds templates for Issues that use the [Issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms) format - Bug Report issue template for reporting bugs with guides - Feature Report issue template for requesting new features - Modify the Pull Request template. Simplifies the form and also adds in some additional descriptions for the user to read before submitting.
Configuration menu - View commit details
-
Copy full SHA for 38cb61e - Browse repository at this point
Copy the full SHA 38cb61eView commit details
Commits on Jun 4, 2024
-
# Description Remove link-check from Checks workflow. The Nuxt SEO module already has a link-checker that will run on build. Add environment to workflows to provide configuration for workflows. Workflows will display by environments and hook up with slack notifications for deployments.
Configuration menu - View commit details
-
Copy full SHA for 1e22d31 - Browse repository at this point
Copy the full SHA 1e22d31View commit details -
chore: setup redirects for old urls (#99)
# Description We have a number of links out there that exist that point to pages that will eventually no longer exist when the new Docs site is released. These links need to be set up with rewrites to ensure visitors still get to the pages they're trying to get to. All existing tutorials that are in Code Community have rewrites directed to them. Any tutorials that do not exist in the Code Community will be redirected to the total list of tutorials on Code Community. Eventually these public links will be updated to point to the new URLs. Part of [DEVRL-730](https://linear.app/matterlabs/issue/DEVRL-730/[launch]-handle-rewrites-for-old-urls)
Configuration menu - View commit details
-
Copy full SHA for 2aada70 - Browse repository at this point
Copy the full SHA 2aada70View commit details -
Removes message hash from quickstart (#101)
# Description Updates quickstart tutorial to remove message hashing as it adds unnecessary complexity. Also updates screenshots. To be merged with: zkSync-Community-Hub/zksync-quickstart-remix#1 ## Linked Issues <!-- If you have any issues this PR is related to, link them here. --> <!-- Check out https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue on how to automate linking a GitHub Issue to a PR. --> ## Additional context
Configuration menu - View commit details
-
Copy full SHA for 1312751 - Browse repository at this point
Copy the full SHA 1312751View commit details -
chore: add concurrency rules to workflows (#102)
# Description Add concurrency rules to workflows for staging and production deploy workflows. This cancels any currently running workflow when a new workflow is set to run. For example when two PRs are merged to main around the same time, one will cancel out the other and only one workflow is run to deploy. This makes it so that we don't have a queue of build and deploys to run, cutting down time and resources. Fix yaml formatting errors with github issue templates. They do not list in Create Issues if format is incorrect.
Configuration menu - View commit details
-
Copy full SHA for 26c9d06 - Browse repository at this point
Copy the full SHA 26c9d06View commit details
Commits on Jun 5, 2024
-
docs: small improvements (#106)
# Description Small edits to build pages based on feedback. Move cards on Build / Introduction page up to the top to prioritize them. Improved wording on funding wallets with testnet funds on Build / Connect to zkSync Add redirects for old /sdks paths to point to the new /sdk path
Configuration menu - View commit details
-
Copy full SHA for 6c665c1 - Browse repository at this point
Copy the full SHA 6c665c1View commit details -
docs: add dappradar links to ecosystem pages (#103)
# Description Provides additional links to dappradar for additional lists of resources. Resolves DEVRL-710
Configuration menu - View commit details
-
Copy full SHA for 173db74 - Browse repository at this point
Copy the full SHA 173db74View commit details -
chore: update links for prod release (#107)
# Description Update project to prepare for production release.
Configuration menu - View commit details
-
Copy full SHA for 4f2d142 - Browse repository at this point
Copy the full SHA 4f2d142View commit details -
chore: edit secret scanner name (#109)
# Description Get trufflehog working again.
Configuration menu - View commit details
-
Copy full SHA for 8a8d29c - Browse repository at this point
Copy the full SHA 8a8d29cView commit details -
Configuration menu - View commit details
-
Copy full SHA for fd93bdd - Browse repository at this point
Copy the full SHA fd93bddView commit details