Merge pull request #6 from verifier-alliance/replace-docs-page-with-embedded-readme

Replace transformations and artifacts pages with github embedded readme

Author: marcocastignoli

docs/2. database-schema.md

@@ -2,7 +2,7 @@
 
 Verifier Alliance's database schema is in PostgreSQL and is intended to be a standard for storing and accessing verified smart contract data.
 
-In essence every smart contract verification (`verified_contracts` table) is a mapping between a compilation (`compiled_contracts`) and a deployment (`contract_deployments`). In addition `verified_contracts` defines "transformations". These are changes need to be made on the **recompiled bytecode** to reach the **onchain bytecode**. Transformations can be replacements of non-executional parts of the bytecode (e.g. immutables, libraries, metadata) or insertions at the end such as constructor arguments. Read more about them in the [transformations docs](/docs/transformations).
+In essence every smart contract verification (`verified_contracts` table) is a mapping between a compilation (`compiled_contracts`) and a deployment (`contract_deployments`). In addition `verified_contracts` defines "transformations". These are changes need to be made on the **recompiled bytecode** to reach the **onchain bytecode**. Transformations can be replacements of non-executional parts of the bytecode (e.g. immutables, libraries, metadata) or insertions at the end such as constructor arguments. Read more about them in the [Transformations and Artifacts docs](/docs/transformations-artifacts).
 
 For deduplicating the source files and the bytecode across verifications the schema also includes a `code` and `sources` table with hashes.
 

docs/3. Transformations and Artifacts.mdx

@@ -0,0 +1,10 @@
+---
+title: Transformations and Artifacts
+id: transformations-artifacts
+---
+
+Transformations and artifacts are outputs of smart‑contract compilation and verification. Compilation artifacts include interface objects such as the ABI and detailed compiler data like the storage layout. Transformations come from verification; applying them to compiled bytecode yields the onchain bytecode. The next section explains and defines the structure of transformations and artifacts.
+
+import EmbedReadmeTransformations from "./EmbedReadmeTransformations";
+
+<EmbedReadmeTransformations />

docs/3. transformations.md

@@ -0,0 +1,49 @@
+import React, { useEffect, useState } from "react";
+import { parse } from "marked";
+
+export default function EmbedReadme({ repo, branch, readmePath, rawBaseUrl, pageBaseUrl }) {
+  const [content, setContent] = useState();
+
+  useEffect(() => {
+    fetch(rawBaseUrl + "/" + repo + "/" + branch + readmePath)
+      .then((response) => response.text())
+      .then((text) => {
+        // Replace relative markdown links with absolute ones
+        // Matches markdown links that don't start with "http"
+        const processedText = text.replace(/\[([^\]]+)\]\((?!http)([^)]+)\)/g, (match, title, path) => {
+          // Handle anchor links
+          if (path.startsWith("#")) {
+            return `[${title}](${pageBaseUrl}/${repo}/tree/${branch}${readmePath}${path})`;
+          }
+
+          // Resolve relative paths (including ../)
+          const currentPath = readmePath.split("/").slice(0, -1);
+          const pathParts = path.split("/");
+
+          let resolvedPath = [...currentPath];
+          for (const part of pathParts) {
+            if (part === "..") {
+              resolvedPath.pop();
+            } else {
+              resolvedPath.push(part);
+            }
+          }
+
+          return `[${title}](${pageBaseUrl}/${repo}/tree/${branch}/${resolvedPath.join("/")})`;
+        });
+        setContent(parse(processedText));
+      });
+  }, []);
+
+  if (!content) return "Loading from " + rawBaseUrl + readmePath + "...";
+  return (
+    <div>
+      <div>
+        <i>
+          Content from <a href={`${pageBaseUrl}/${repo}/tree/${branch}${readmePath}`}>{repo + readmePath}</a>
+        </i>
+      </div>
+      <div dangerouslySetInnerHTML={{ __html: content }} />{" "}
+    </div>
+  );
+}

docs/4. artifacts.md

@@ -0,0 +1,19 @@
+import EmbedReadme from "./EmbedReadme";
+import React from "react";
+const repo = "verifier-alliance/database-specs";
+const branch = "master";
+const readmePath = "/json-schemas/README.md";
+const rawBaseUrl = "https://raw.githubusercontent.com";
+const pageBaseUrl = "https://github.com";
+
+export default function() {
+  return (
+    <EmbedReadme
+      repo={repo}
+      branch={branch}
+      readmePath={readmePath}
+      rawBaseUrl={rawBaseUrl}
+      pageBaseUrl={pageBaseUrl}
+    />
+  );
+}