docs: update torii reference to reflect rc.1 (#513)

* fix: extend default theme correctly

Signed-off-by: quacumque <[email protected]>

* docs: update torii reference according to `rc.1.0`

Signed-off-by: quacumque <[email protected]>

* ci: bump node version

Signed-off-by: quacumque <[email protected]>

* ci: update corepack to latest

Signed-off-by: quacumque <[email protected]>

* docs: fix broken anchor

Signed-off-by: quacumque <[email protected]>

* Apply suggestions from code review

Co-authored-by: Alexandra Zorina <[email protected]>
Signed-off-by: 0x009922 <[email protected]>

* docs: update iroha rev, revise query section

Signed-off-by: qua <[email protected]>

* docs: refine queries table

Signed-off-by: qua <[email protected]>

---------

Signed-off-by: quacumque <[email protected]>
Signed-off-by: 0x009922 <[email protected]>
Signed-off-by: qua <[email protected]>
Co-authored-by: quacumque <[email protected]>
Co-authored-by: Alexandra Zorina <[email protected]>

Author: 0x009922

.github/workflows/pull-request-ci.yaml

@@ -10,13 +10,15 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
 
       # --- Install with caching
       # https://github.com/pnpm/action-setup#use-cache-to-reduce-installation-time
 
       - name: Enable Corepack
-        run: corepack enable
+        run: |
+          npm i -g corepack@latest
+          corepack enable
 
       - name: Get pnpm store directory
         id: pnpm-cache

.vitepress/theme/index.ts

@@ -10,7 +10,7 @@ import './style/index.scss'
 import { defineAsyncComponent } from 'vue'
 
 export default {
-  ...ThemeDefault,
+  extends: ThemeDefault,
   Layout: LayoutCustom,
   enhanceApp({ app }: EnhanceAppContext) {
     app.component('MermaidRenderWrap', MermaidRenderWrap)
@@ -23,4 +23,4 @@ export default {
       defineAsyncComponent(async () => import('./components/CompatibilityMatrixTableIcon.vue')),
     )
   },
-}
+} satisfies import('vitepress').Theme

etc/meta.ts

@@ -1,7 +1,4 @@
-/**
- * hyperledger-iroha/iroha#iroha2-dev
- */
-export const IROHA_REV_DEV = 'e7a605c1a926c319d214ef3825524ee6c2e9f076'
+export const IROHA_RC_1 = 'v2.0.0-rc.1.0'
 
 /**
  * hyperledger-iroha/iroha-javascript#iroha2 (rc13)

etc/schema/render.ts

@@ -3,8 +3,13 @@ import { match, P } from 'ts-pattern'
 // https://github.com/vuejs/vitepress/blob/b16340acbd3c60fee023daadb0ec5a0292060a1e/src/node/markdown/markdown.ts#L13
 import { slugify } from '@mdit-vue/shared'
 
+function typeSlug(type: string) {
+  if (type === '()') return `unit`
+  return slugify(type)
+}
+
 function segmentHeading(content: string) {
-  return `## ${code(content)}`
+  return `## ${code(content)} {#${typeSlug(content)}}`
 }
 
 function segmentPropNameOnly(prop: string) {
@@ -32,7 +37,7 @@ function tyMdLink(ty: string) {
       'String',
       (x) => `${code(x)}`,
     )
-    .otherwise((ty) => `[${code(ty)}](#${slugify(ty)})`)
+    .otherwise((ty) => `[${code(ty)}](#${typeSlug(ty)})`)
 }
 
 function code(content: string) {
@@ -97,7 +102,14 @@ function renderSegment(segment: Segment, segmentName: string): string {
         segmentType('Enum'),
         segmentPropNameOnly('Variants'),
         table(
-          [{ title: 'Variant name', align: 'right' }, { title: 'Variant value', align: 'left' }, 'Discriminant'],
+          [
+            { title: 'Variant name', align: 'right' },
+            {
+              title: 'Variant value',
+              align: 'left',
+            },
+            'Discriminant',
+          ],
           variants.map((x) => [code(x.tag), x.type ? tyMdLink(x.type) : `—`, String(x.discriminant)]),
           { indent: '  ' },
         ),

etc/snippet-sources.ts

@@ -1,5 +1,5 @@
 import type { SnippetSourceDefinition } from './types'
-import { IROHA_JAVA_REV_DEV, IROHA_JS_REV, IROHA_REV_DEV } from './meta'
+import { IROHA_JAVA_REV_DEV, IROHA_JS_REV, IROHA_RC_1 } from './meta'
 import { render as renderDataModelSchema } from './schema'
 
 // *****
@@ -102,11 +102,11 @@ const javascriptSnippets = [
 
 export default [
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/MAINTAINERS.md`,
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/MAINTAINERS.md`,
     filename: 'iroha-maintainers.md',
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/docs/source/references/schema.json`,
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/docs/source/references/schema.json`,
     filename: `data-model-schema.md`,
     transform: (source) => {
       return renderDataModelSchema(JSON.parse(source))
@@ -116,18 +116,18 @@ export default [
     src: './src/example_code/lorem.rs',
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/configs/client.template.toml`,
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/docs/source/references/client.template.toml`,
     filename: 'client-cli-config-template.toml',
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/configs/peer.template.toml`,
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/docs/source/references/peer.template.toml`,
     filename: 'peer-config-template.toml',
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/configs/swarm/genesis.json`,
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/defaults/genesis.json`,
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/client/examples/tutorial.rs`,
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/crates/iroha/examples/tutorial.rs`,
     filename: 'tutorial-snippets.rs',
   },