Remote Substreams docs #346

dimaMachina · 2023-04-24T19:08:47Z

simplify _app.tsx
simplify pages/[locale]/index.mdx (use better approach than proposed in Simplify _app.tsx #344)
setup remote MDX for https://substreams.streamingfast.io/ https://github.com/streamingfast/substreams/tree/develop/docs

⚠️ Sometimes we can get API rate limit from https://api.github.com/repos/streamingfast/substreams/git/trees/develop?recursive=1 (URL for getting all available docs files).

Let's test it for now as is and in the future we can fetch this data only once while building our app
error - Error: {
 "message": "API rate limit exceeded for 37.65.12.11. (But here's the good news: Authenticated requests get a higher rate > limit. Check out the documentation for more details.)",
 "documentation_url": "https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting"
}

dimaMachina · 2023-04-24T19:12:36Z

website/pages/[locale]/index.mdx

+  const rawMdx = `---
+title: ${t('index.title')}
+---
+
+${t('index.intro')}
+
+<Intro />
+
+## ${t('index.networkRoles.title')}
+
+${t('index.networkRoles.description')}
+
+<NetworkRoles />
+
+## ${t('index.products.title')}
+
+<Products />
+
+## ${t('index.supportedNetworks.title')}
+
+${t('index.supportedNetworks.description')}
+
+<SupportedNetworks />`


this looks pretty, + we avoid ugly code to inject frontmatter and headings for TOC

Yes, this is great!

dimaMachina · 2023-04-24T19:13:35Z

website/components/_app.tsx

-    )
-    return pageMap
-  }, [__nextra_internal__.pageMap, hasMDXPage, locale])
+const localeSwitcher = <LocaleSwitcher key="localeSwitcher" />


we can avoid useMemo and just render component outside function declaration

dimaMachina · 2023-04-24T20:42:15Z

website/package.json

    "react": "^18.2.0",
    "react-dom": "^18.2.0",
+    "sharp": "^0.32.0",


benface · 2023-04-25T17:30:41Z

website/next.config.js

+      const banner = `
+import { getPageMap } from '@/components/get-page-map'
+
+export const getStaticProps = async context => ({
+  props: {
+    __nextra_pageMap: await getPageMap('${route.split('/')[1]}')
+  }
+})`
+      result += banner


What does banner mean here?

the piece of code to include getStaticProps for pages that don't have it

benface · 2023-04-25T17:32:00Z

website/pages/en/substreams/[[...slug]].mdx

Oh, this is cool!

benface · 2023-04-25T17:33:03Z

website/pages/en/substreams/[[...slug]].mdx

+        () => (tree, _file, done) => {
+          const GITBOOK_CALLOUT_REGEX = /{%.*?%}/
+          visit(tree, 'paragraph', (node) => {
+            for (const child of node.children) {
+              if (child.value) {
+                child.value = child.value.replace(GITBOOK_CALLOUT_REGEX, '')
+              }
+            }
+          })
+          done()
+        },


What are these "callouts" that you're removing?

something like this https://docs.gitbook.com/content-creation/blocks/hint#git-sync-representation-in-markdown

Note: I remove only callout tags not the callout itself

Got it, thank you.

benface

Great work!

Looks like the substreams docs are only available in English at the moment, and they cannot be translated through Crowdin because they are not in this repo. Do we have any plans for that?

dimaMachina · 2023-04-26T10:14:58Z

Looks like the substreams docs are only available in English at the moment, and they cannot be translated through Crowdin because they are not in this repo. Do we have any plans for that?

either setup another source for crowdin

Input:
https://github.com/streamingfast/substreams/tree/develop/docs

Output:
https://github.com/graphprotocol/docs/tree/main/website/pages

or just download raw .md files to https://github.com/graphprotocol/docs/blob/main/website/pages/en/substreams folder

But if we do it we don't need even Remote MDX since all Substreams docs will be restored inside this repo

benface · 2023-04-28T04:08:17Z

@B2o5T – Something else that I noticed: the substreams pages don't set the current page's title in the <title>. It's always just The Graph Docs, as opposed to e.g. Running Substreams - The Graph Docs.

* Hide locale switcher on `/en/substreams` pages * Trailing slashes are important, apparently

dimaMachina commented Apr 24, 2023

View reviewed changes

dimaMachina force-pushed the substreams branch from 5246497 to b231c22 Compare April 24, 2023 19:20

This comment was marked as duplicate.

Sign in to view

dimaMachina marked this pull request as ready for review April 24, 2023 19:30

dimaMachina requested a review from a team as a code owner April 24, 2023 19:30

graphprotocol deleted a comment from github-actions bot Apr 24, 2023

dimaMachina commented Apr 24, 2023

View reviewed changes

website/package.json

"react": "^18.2.0",

"react-dom": "^18.2.0",

"sharp": "^0.32.0",

Copy link

Contributor Author

dimaMachina Apr 24, 2023

Choose a reason for hiding this comment

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

This comment was marked as resolved.

Sign in to view

dotansimha approved these changes Apr 25, 2023

View reviewed changes

saihaj approved these changes Apr 25, 2023

View reviewed changes

benface reviewed Apr 25, 2023

View reviewed changes

website/pages/en/substreams/[[...slug]].mdx

Copy link

Contributor

benface Apr 25, 2023

Choose a reason for hiding this comment

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

Oh, this is cool!

benface reviewed Apr 25, 2023

View reviewed changes

benface approved these changes Apr 25, 2023

View reviewed changes

dimaMachina added 4 commits April 26, 2023 19:11

remote substreams docs

12e4996

update next.js/nextra

7ac75bc

fix

8550d31

pnpm i

295e0de

dimaMachina force-pushed the substreams branch from 2c269b5 to 295e0de Compare April 26, 2023 17:12

fix lint

3d2c6d8

benface mentioned this pull request Apr 28, 2023

Hide locale switcher on /en/substreams pages #361

Merged

Hide locale switcher on /en/substreams pages (#361)

deb1635

* Hide locale switcher on `/en/substreams` pages * Trailing slashes are important, apparently

saihaj merged commit a52086f into main May 2, 2023

saihaj deleted the substreams branch May 2, 2023 15:45

dimaMachina mentioned this pull request May 3, 2023

fix page title for remote content #370

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remote Substreams docs #346

Remote Substreams docs #346

dimaMachina commented Apr 24, 2023 •

edited

Loading

dimaMachina Apr 24, 2023

benface Apr 25, 2023

dimaMachina Apr 24, 2023

This comment was marked as duplicate.

dimaMachina Apr 24, 2023

This comment was marked as resolved.

benface Apr 25, 2023

dimaMachina Apr 26, 2023

benface Apr 25, 2023

benface Apr 25, 2023

dimaMachina Apr 26, 2023

benface Apr 26, 2023

benface left a comment

dimaMachina commented Apr 26, 2023

benface commented Apr 28, 2023

Remote Substreams docs #346

Remote Substreams docs #346

Conversation

dimaMachina commented Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as duplicate.

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benface left a comment

Choose a reason for hiding this comment

dimaMachina commented Apr 26, 2023

benface commented Apr 28, 2023

dimaMachina commented Apr 24, 2023 •

edited

Loading