chore: update the glossary, faq and troubleshooting guide

zksync-sdk / sdk-docs

Documentation for 3rd-party SDKs that integrate with zkSync

https://docs.zksync.io/sdk

Apache License 2.0

1 stars 3 forks source link

chore: update the glossary, faq and troubleshooting guide #40

Closed Ngozi-Txfusion closed 3 weeks ago

Ngozi-Txfusion commented 1 month ago

What

put the faq, glossary and troubleshooting guide in the left bar
use collapsible for the faq, glossary and troubleshooting guide
remove the faq, glossary and troubleshooting guide from the main nav

Why

Makes it easier for users to find the FAQ, Glossary, and Troubleshooting Guide.
Reduces clutter in the main navigation.
Collapsible sections provide a more organized and user-friendly layout.

github-actions[bot] commented 1 month ago

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

https://zksync-sdk-docs-staging--pr40-update-sdk-doc-lt9d2z4m.web.app

_{(expires Fri, 21 Jun 2024 07:49:25 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: f6539d831ccfa61081c09db66b409eadb94db989}

itsacoyote commented 1 month ago

We should not remove any of the v5 pages from navigation. Just because v5 is obsolete does not mean that we can drop the documentation support for it. Adding the _ to the files removes them from navigation and are no longer accessible.

Ngozi-Txfusion commented 1 month ago

We should not remove any of the v5 pages from navigation. Just because v5 is obsolete does not mean that we can drop the documentation support for it. Adding the _ to the files removes them from navigation and are no longer accessible.

Since the content were repetition, that was why I removed them but I've added them now

itsacoyote commented 4 weeks ago

We should not remove any of the v5 pages from navigation. Just because v5 is obsolete does not mean that we can drop the documentation support for it. Adding the _ to the files removes them from navigation and are no longer accessible.

Since the content were repetition, that was why I removed them but I've added them now

We can remove them at a later point, but unfortunately we have links referring to those pages and users likely still visiting them. We need to do a more progressive set of steps to safely remove those pages.

github-actions[bot] commented 2 weeks ago

:tada: This PR is included in version 1.2.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: