Skip to content

Commit

Permalink
feat: add sdk docs as part of build (#80)
Browse files Browse the repository at this point in the history
# 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.
  • Loading branch information
itsacoyote authored May 21, 2024
1 parent f367a05 commit 2acfb7c
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 4 deletions.
Binary file modified bun.lockb
Binary file not shown.
2 changes: 1 addition & 1 deletion content/00.build/70.api-reference/20.zks-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -1223,7 +1223,7 @@ relationships between each other.

#### Example Request

```curl
```sh
curl -X POST -H "Content-Type: application/json" \
--data '{"jsonrpc":"2.0","method":"eth_sendRawTransaction","params":["Signed Transaction"],"id":1}' \
"https://mainnet.era.zksync.io"
Expand Down
4 changes: 2 additions & 2 deletions error.vue
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ provide('navigation', navigation);

<template>
<div>
<Header />
<HeaderComponent :search="true" />

<UMain>
<UContainer>
Expand All @@ -41,7 +41,7 @@ provide('navigation', navigation);
</UContainer>
</UMain>

<Footer />
<FooterComponent />

<ClientOnly>
<LazyUContentSearch
Expand Down
13 changes: 12 additions & 1 deletion nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
extends: [['github:matter-labs/docs-nuxt-template', { install: true }]],
extends: [['github:matter-labs/docs-nuxt-template', { install: true }], ['github:zksync-sdk/sdk-docs#staging']],
modules: ['@nuxt/content', '@nuxt/ui', '@nuxt/eslint', '@nuxtjs/seo'],
routeRules: {
'/api/search.json': { prerender: true },
Expand All @@ -9,6 +9,17 @@ export default defineNuxtConfig({
name: 'zkSync Docs',
url: process.env.NUXT_SITE_ENV ? 'https://staging-docs.zksync.io' : 'https://docs.zksync.io',
},
content: {
sources: {
sdk: {
prefix: '/sdk',
driver: 'github',
repo: 'zksync-sdk/sdk-docs',
branch: 'staging',
dir: 'content/sdk',
},
},
},
runtimeConfig: {
public: {
app: 'docs',
Expand Down

0 comments on commit 2acfb7c

Please sign in to comment.