@maci-protocol/website 0.0.0-ci.01622be

package/src/icons/IconDiscord.tsx

@@ -0,0 +1,16 @@
+import React from "react";
+
+interface IconDiscordProps extends React.SVGProps<SVGSVGElement> {
+  size?: number;
+}
+
+const IconDiscord: React.FC<IconDiscordProps> = ({ size = 24, ...props }) => (
+  <svg fill="none" height={size} viewBox="0 0 24 19" width={size} xmlns="http://www.w3.org/2000/svg" {...props}>
+    <path
+      d="M20.242 1.68563C18.7262 0.990122 17.1007 0.4777 15.4012 0.184215C15.3703 0.17855 15.3393 0.192705 15.3234 0.221016C15.1144 0.592826 14.8828 1.07788 14.7206 1.45913C12.8927 1.18547 11.0741 1.18547 9.28367 1.45913C9.12148 1.06941 8.88152 0.592826 8.67153 0.221016C8.65559 0.19365 8.62467 0.179495 8.59372 0.184215C6.89513 0.476762 5.26967 0.989184 3.75294 1.68563C3.73981 1.69129 3.72855 1.70074 3.72108 1.713C0.637926 6.31917 -0.206681 10.8121 0.207655 15.2494C0.20953 15.2711 0.221716 15.2919 0.23859 15.3051C2.27277 16.7989 4.24322 17.7058 6.17708 18.3069C6.20803 18.3164 6.24082 18.3051 6.26052 18.2796C6.71797 17.6549 7.12576 16.9962 7.47539 16.3035C7.49602 16.2629 7.47632 16.2148 7.43415 16.1987C6.78734 15.9534 6.17145 15.6542 5.57901 15.3145C5.53215 15.2871 5.5284 15.2201 5.57151 15.188C5.69618 15.0946 5.82088 14.9974 5.93993 14.8992C5.96147 14.8813 5.99148 14.8775 6.0168 14.8889C9.90891 16.6659 14.1226 16.6659 17.9688 14.8889C17.9941 14.8766 18.0241 14.8804 18.0466 14.8983C18.1656 14.9965 18.2903 15.0946 18.4159 15.188C18.459 15.2201 18.4562 15.2871 18.4094 15.3145C17.8169 15.6608 17.201 15.9534 16.5533 16.1978C16.5111 16.2138 16.4924 16.2629 16.513 16.3035C16.8701 16.9952 17.2779 17.6539 17.7269 18.2786C17.7457 18.3051 17.7794 18.3164 17.8104 18.3069C19.7536 17.7058 21.724 16.7989 23.7582 15.3051C23.776 15.2919 23.7873 15.272 23.7892 15.2503C24.285 10.1204 22.9586 5.66426 20.2729 1.71394C20.2663 1.70074 20.2551 1.69129 20.242 1.68563ZM8.05661 12.5476C6.88482 12.5476 5.9193 11.4718 5.9193 10.1506C5.9193 8.8294 6.86609 7.75361 8.05661 7.75361C9.25647 7.75361 10.2126 8.83884 10.1939 10.1506C10.1939 11.4718 9.24709 12.5476 8.05661 12.5476ZM15.959 12.5476C14.7872 12.5476 13.8217 11.4718 13.8217 10.1506C13.8217 8.8294 14.7684 7.75361 15.959 7.75361C17.1589 7.75361 18.115 8.83884 18.0963 10.1506C18.0963 11.4718 17.1589 12.5476 15.959 12.5476Z"
+      fill="currentColor"
+    />
+  </svg>
+);
+
+export default IconDiscord;

package/src/icons/IconGithub.tsx

@@ -0,0 +1,16 @@
+import React from "react";
+
+interface IconGithubProps extends React.SVGProps<SVGSVGElement> {
+  size?: number;
+}
+
+const IconGithub: React.FC<IconGithubProps> = ({ size = 22, ...props }) => (
+  <svg fill="none" height={size} viewBox="0 0 22 23" width={size} xmlns="http://www.w3.org/2000/svg" {...props}>
+    <path
+      d="M10.9997 2.69641C5.93509 2.69641 1.83301 6.79849 1.83301 11.8631C1.83197 13.7874 2.43692 15.6632 3.56204 17.2244C4.68716 18.7855 6.27531 19.9527 8.10118 20.5604C8.55951 20.6402 8.73093 20.3652 8.73093 20.1241C8.73093 19.9068 8.71901 19.1854 8.71901 18.4172C6.41634 18.8417 5.82051 17.8562 5.63718 17.3402C5.53359 17.0762 5.08718 16.2631 4.69759 16.0449C4.37676 15.8735 3.91843 15.4491 4.68568 15.4381C5.40801 15.4262 5.92318 16.1027 6.09551 16.3777C6.92051 17.7637 8.23868 17.3741 8.76484 17.1339C8.84551 16.5381 9.08568 16.1375 9.34968 15.9083C7.31009 15.6792 5.17884 14.8881 5.17884 11.3818C5.17884 10.3845 5.53359 9.56041 6.11843 8.91783C6.02676 8.68866 5.70593 7.74908 6.21009 6.48866C6.21009 6.48866 6.97734 6.24849 8.73093 7.42916C9.47715 7.22205 10.2482 7.11781 11.0226 7.11933C11.8018 7.11933 12.5809 7.22199 13.3143 7.42824C15.0669 6.23658 15.8351 6.48958 15.8351 6.48958C16.3393 7.74999 16.0184 8.68958 15.9268 8.91874C16.5107 9.56041 16.8663 10.3735 16.8663 11.3818C16.8663 14.9 14.7241 15.6792 12.6845 15.9083C13.0163 16.1943 13.3033 16.7443 13.3033 17.6042C13.3033 18.8297 13.2913 19.8152 13.2913 20.125C13.2913 20.3652 13.4637 20.6512 13.922 20.5595C15.7416 19.9451 17.3228 18.7757 18.4429 17.2156C19.5631 15.6556 20.1658 13.7836 20.1663 11.8631C20.1663 6.79849 16.0643 2.69641 10.9997 2.69641Z"
+      fill="currentColor"
+    />
+  </svg>
+);
+
+export default IconGithub;

package/src/icons/IconWebsite.tsx

@@ -0,0 +1,16 @@
+import React from "react";
+
+interface IconWebsiteProps extends React.SVGProps<SVGSVGElement> {
+  size?: number;
+}
+
+const IconWebsite: React.FC<IconWebsiteProps> = ({ size = 18, ...props }) => (
+  <svg fill="none" height={size} viewBox="0 0 18 18" width={size} xmlns="http://www.w3.org/2000/svg" {...props}>
+    <path
+      d="M9.00033 17.1963C4.39783 17.1963 0.666992 13.4655 0.666992 8.863C0.666992 4.2605 4.39783 0.529663 9.00033 0.529663C13.6028 0.529663 17.3337 4.2605 17.3337 8.863C17.3337 13.4655 13.6028 17.1963 9.00033 17.1963ZM7.09199 15.2522C6.26984 13.5083 5.79355 11.6215 5.68949 9.69633H2.38533C2.54748 10.9787 3.07859 12.1865 3.91413 13.1728C4.74967 14.159 5.85367 14.8814 7.09199 15.2522V15.2522ZM7.35866 9.69633C7.48449 11.7288 8.06533 13.638 9.00033 15.323C9.96059 13.5935 10.5215 11.6709 10.642 9.69633H7.35866V9.69633ZM15.6153 9.69633H12.3112C12.2071 11.6215 11.7308 13.5083 10.9087 15.2522C12.147 14.8814 13.251 14.159 14.0865 13.1728C14.9221 12.1865 15.4532 10.9787 15.6153 9.69633V9.69633ZM2.38533 8.02966H5.68949C5.79355 6.10448 6.26984 4.21773 7.09199 2.47383C5.85367 2.84456 4.74967 3.56696 3.91413 4.55324C3.07859 5.53953 2.54748 6.74725 2.38533 8.02966V8.02966ZM7.35949 8.02966H10.6412C10.521 6.05516 9.9603 4.13261 9.00033 2.403C8.04006 4.13254 7.47912 6.0551 7.35866 8.02966H7.35949ZM10.9087 2.47383C11.7308 4.21773 12.2071 6.10448 12.3112 8.02966H15.6153C15.4532 6.74725 14.9221 5.53953 14.0865 4.55324C13.251 3.56696 12.147 2.84456 10.9087 2.47383V2.47383Z"
+      fill="currentColor"
+    />
+  </svg>
+);
+
+export default IconWebsite;

package/src/pages/blogs.tsx

@@ -0,0 +1,58 @@
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import Layout from "@theme/Layout";
+import LayoutProvider from "@theme/Layout/Provider";
+import React from "react";
+
+import styles from "../css/card.module.css";
+
+interface BlogPost {
+  title: string;
+  date: string;
+  slug: string;
+  description: string;
+  authorName: string;
+  tags: string[];
+  excerpt: string;
+}
+
+/**
+ * Renders a list of blog posts.
+ *
+ * @returns {JSX.Element} The rendered blog page.
+ */
+const BlogPage: React.FC = () => {
+  const { siteConfig } = useDocusaurusContext();
+  const blogPosts: BlogPost[] = (siteConfig.customFields?.blogPosts ?? []) as BlogPost[];
+
+  if (blogPosts.length === 0) {
+    return <div>No blog posts available.</div>;
+  }
+
+  return (
+    <LayoutProvider>
+      <Layout title="Blog">
+        <div className={styles.blogContainer}>
+          <div className={styles.blogList}>
+            {blogPosts.map((post: BlogPost) => (
+              <a key={post.slug} className={styles.blogCard} href={`/blog/${post.slug}`}>
+                <h2 className={styles.blogTitle}>{post.title}</h2>
+
+                <p className={styles.blogDescription}>{post.description}</p>
+
+                <p className={styles.blogDate}>{post.date}</p>
+
+                <p className={styles.blogAuthors}>By {post.authorName}</p>
+
+                <p className={styles.blogExcerpt}>{post.excerpt}</p>
+
+                <span className={styles.blogReadMoreButton}>Read More</span>
+              </a>
+            ))}
+          </div>
+        </div>
+      </Layout>
+    </LayoutProvider>
+  );
+};
+
+export default BlogPage;

package/src/pages/index.module.css

@@ -0,0 +1,152 @@
+/**
+ * CSS files with the .module.css suffix will be treated as CSS modules
+ * and scoped locally.
+ */
+
+.heroBanner {
+  position: relative;
+  height: 427px;
+  overflow: hidden;
+  background-image:
+    linear-gradient(to bottom, rgba(0, 0, 0, 0.3) 0%, rgba(0, 0, 0, 0.3) 100%), url("../../static/img/hero.svg");
+  background-position: 0% 75%;
+  background-repeat: no-repeat;
+  background-size: cover;
+  flex-direction: column;
+  justify-content: center;
+  align-items: start;
+  padding: 8rem;
+  color: var(--ifm-color-hero);
+  font-family: ShareTechMono;
+  gap: 1rem;
+}
+
+.heroTitle {
+  border: 2px solid white;
+  border-radius: 4px;
+  padding: 0rem 0.75rem;
+  font-size: 2.5rem;
+  line-height: 3.5rem;
+  letter-spacing: -0.1rem;
+}
+
+.heroTagline {
+  font-size: 4.5rem;
+  line-height: 5rem;
+}
+
+.buttons {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+.introduction {
+  display: flex;
+  align-items: center;
+  padding: 4rem;
+  width: 100%;
+  font-size: 1.1rem;
+}
+
+.blue {
+  color: var(--ifm-link-color);
+}
+
+.borderBlue {
+  text-decoration: underline;
+  text-decoration-color: var(--ifm-link-color);
+  text-underline-offset: 0.5rem;
+  margin-bottom: 1rem;
+}
+
+.projectsPage {
+  width: 100%;
+}
+
+.heroSection {
+  padding-top: 170px;
+  padding-bottom: 56px;
+  width: 100%;
+  position: relative;
+  display: flex;
+  justify-content: flex-end;
+  align-items: flex-start;
+}
+
+.backgroundImage {
+  position: absolute;
+  top: 0;
+  left: 50%;
+  transform: translateX(-50%);
+  width: 100vw;
+  height: 100%;
+  overflow: hidden;
+  z-index: -1;
+}
+
+.backgroundImage img {
+  width: 100%;
+  height: 100%;
+  object-fit: cover;
+}
+
+.heroContent {
+  padding-bottom: 64px;
+}
+
+.heroContent h1 {
+  font-size: 72px;
+  margin-bottom: 16px;
+}
+
+.heroContent p {
+  font-size: 20px;
+}
+
+.actionSection {
+  margin-top: 128px;
+  margin-bottom: 128px;
+}
+
+/* Responsive styles */
+@media (max-width: 768px) {
+  .heroContent h1 {
+    font-size: 46px;
+  }
+
+  .heroContent p {
+    font-size: 18px;
+  }
+}
+
+@media (max-width: 480px) {
+  .heroContent h1 {
+    font-size: 40px;
+  }
+
+  .heroContent p {
+    font-size: 16px;
+  }
+}
+
+@media screen and (max-width: 996px) {
+  .heroBanner {
+    padding: 1.5rem;
+  }
+
+  .introduction {
+    padding: 1.5rem;
+  }
+
+  .heroTitle {
+    font-size: 1.5rem;
+    line-height: 2.25rem;
+    padding: 0rem 0.5rem;
+  }
+
+  .heroTagline {
+    font-size: 2.5rem;
+    line-height: 3rem;
+  }
+}

package/src/pages/index.tsx

@@ -0,0 +1,66 @@
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import Layout from "@theme/Layout";
+import LayoutProvider from "@theme/Layout/Provider";
+import clsx from "clsx";
+
+import type { ReactElement } from "react";
+
+import HomepageFeatures from "../components/HomepageFeatures";
+
+import styles from "./index.module.css";
+
+interface HomepageHeaderProps {
+  tagline: string;
+  title: string;
+}
+
+const HomepageHeader = ({ tagline, title }: HomepageHeaderProps) => (
+  <header className={clsx("hero hero--dark", styles.heroBanner)}>
+    <div className={styles.heroTitle}>{title}</div>
+
+    <div className={styles.heroTagline}>
+      {tagline}
+
+      <span className={styles.blue}>.</span>
+    </div>
+  </header>
+);
+
+const Home = (): ReactElement => {
+  const { siteConfig } = useDocusaurusContext();
+
+  return (
+    <LayoutProvider>
+      <Layout
+        description="Minimal Anti-Collusion Infrastructure (MACI) is an on-chain voting platform which protects privacy and minimizes the risk of collusion and bribery"
+        title={`Minimal Anti-Collusion Infrastructure (${siteConfig.title})`}
+      >
+        <HomepageHeader tagline={siteConfig.tagline} title={siteConfig.title} />
+
+        <main>
+          <section className={styles.introduction}>
+            <div className="container">
+              <h2 className={styles.borderBlue}>What is MACI?</h2>
+
+              <p>Minimal Anti-Collusion Infrastructure (MACI) is a private, on-chain, voting system.</p>
+
+              <p>
+                MACI is our attempt to build the most secure e-voting solution available. It enables on-chain voting
+                processes with significantly reduced risk of cheating, like bribery or collusion, through the use of
+                Ethereum smart contracts, encryption, and zero-knowledge proofs. Together these technologies provide a
+                set of guarantees including censorship resistance, correct execution, privacy, and a receipt-free voting
+                scheme, which ensures results are transparent but makes it impossible for outsiders to verify how any
+                specific user voted. We believe MACI is most beneficial for governance and funding events, when the
+                stakes are high and anti-collusion mechanisms are critical to help ensure fair and transparent outcomes.
+              </p>
+            </div>
+          </section>
+
+          <HomepageFeatures />
+        </main>
+      </Layout>
+    </LayoutProvider>
+  );
+};
+
+export default Home;

package/src/pages/projects.tsx

@@ -0,0 +1,44 @@
+import Layout from "@theme/Layout";
+import LayoutProvider from "@theme/Layout/Provider";
+import clsx from "clsx";
+
+import ProjectsList from "../components/ProjectList";
+
+import styles from "./index.module.css";
+
+interface ProjectspageHeaderProps {
+  tagline: string;
+  title: string;
+}
+
+const ProjectspageHeader = ({ tagline, title }: ProjectspageHeaderProps) => (
+  <header className={clsx("hero hero--dark", styles.heroBanner)}>
+    <div className={styles.heroTitle}>{title}</div>
+
+    <div className={styles.heroTagline}>
+      {tagline}
+
+      <span className={styles.blue}>.</span>
+    </div>
+  </header>
+);
+
+const Projects: React.FC = () => (
+  <LayoutProvider>
+    <Layout description="A list of projects built with the MACI protocol" title="Projects built with MACI">
+      <div>
+        <ProjectspageHeader tagline="Explore the projects built by the MACI community" title="Projects" />
+      </div>
+
+      <main>
+        <section className={styles.introduction}>
+          <div className="container">
+            <ProjectsList />
+          </div>
+        </section>
+      </main>
+    </Layout>
+  </LayoutProvider>
+);
+
+export default Projects;

package/src/pages/roadmap.md

@@ -0,0 +1,109 @@
+---
+title: MACI Product Roadmap
+description: An outline of the 2024 MACI team & product roadmap
+---
+
+# MACI Product Roadmap
+
+_This public roadmap is part of our core team's efforts to make our work more accessible and to foster more collaboration from our open source community. We plan to re-assess & iterate on our roadmap over time, and will update this document when we do._
+
+:::info
+This document aims to outline the 2025 MACI roadmap. Our roadmap is under constant discussion and evolution (e.g. see our [high level 2025 roadmap](/blog/2025-roadmap) updates) but we try our best to maintain this page to provide a high-level overview. Please join the conversation in our [discord server](https://discord.com/invite/sF5CT5rzrR) if you have feedback!
+
+**Last updated: 2025-04-23**
+:::
+
+## Team description
+
+The MACI core team is a small collaborative engineering team building various projects within [Privacy & Scaling Explorations (PSE)](https://pse.dev/). Our sustained focus is on MACI: an on-chain voting protocol that provides greatly increased collusion resistance & privacy. We also allocate a portion of our time to support the practical adoption of this technology by supporting community leaders to run democratic governance and public funding initiatives, like Quadratic Voting (QV), Quadratic Funding (QF), and Retroactive Public Goods Funding (RPGF) grant rounds.
+
+## MACI mission & vision
+
+MACI (Minimal Anti-Collusion Infrastructure) is a public good & a potential core piece of infrastructure for many Ethereum-based applications to support privacy-protecting on-chain governance. Using MACI, individual votes are private but final results are public, so no voter can reveal how they voted yet voting results are verifiable with cryptographic proofs to prevent censorship, bribery, collusion, and other forms of manipulation common in public polling processes.
+
+**Long term, the MACI team’s vision is to build the most secure e-voting solution in the world.**
+
+Short term, our vision is to empower developers to build with MACI to create collusion resistant & privacy-protecting voting applications, like quadratic funding platforms & DAO governance tools. Our goal is to provide an out-of-the-box solution for developers to quickly integrate into their applications & deploy. MACI aims to handle the voting infrastructure so you can focus on building the logic specific to your application.
+
+### High-level MACI ecosystem goals
+
+1. ~~2021: MACI integrated by an ecosystem project~~ (✅, [clr.fund](https://github.com/clrfund/monorepo/))
+2. ~~2023: MACI integrated by a PSE project~~ (✅, [QF](https://github.com/privacy-scaling-explorations/qf))
+3. ~~2024: MACI integrated by an additional external project~~ (✅, [PriVote](https://github.com/PriVote-Project), [Gitcoin](https://github.com/gitcoinco/MACI_QF))
+4. 2025: MACI used by multiple DAOs for governance applications
+5. 2028: MACI used in smaller municipal elections (counties, provinces, etc)
+6. 2030: MACI used in national elections
+
+### High-level MACI development goals
+
+1. ~~2021: release MACI v1.0~~ (✅)
+2. ~~2023: build technical feasibility for 10K concurrent voters on the platform~~ (✅)
+3. 2024:
+
+- ~~Q1: release MACI v1.2, with revamped documentation & educational resource~~ (✅)
+- ~~Q3: release MACI v2.0, with cleaner code and improved UX~~ (✅)
+
+4. 2025: release MACI v3.0, with new features for a more scalable and flexible platform
+5. 2026: build technical feasibility for 100K concurrent voters on the platform
+6. 2028: build technical feasibility for 1M concurrent voters on the platform
+
+# 2025 workstreams
+
+In 2025, we are focusing on several initiatives to support the practical adoption of MACI.
+
+## 1) MACI v3.0
+
+This new version comes with features that have been requested in the past, such as polls being more customisable, in terms of voice credits assigned to voters, and gatekeeping mechanisms.
+
+At a high level, the new features/improvements are:
+
+- Custom voice credits per poll
+- Custom gatekeeping per poll
+- Replacement of vote merkle trees for more efficient hash-chains
+- Offchain voting via MACI's relayer service
+
+## 2) Coordinator Service
+
+The coordinator service is a service to automate MACI coordinator functionality. This includes:
+
+- Contract deployment
+- Subgraph deploying
+- Proof generation
+- Proof and results submission
+
+This service exposes a REST API, as well as some Websocket endpoints (for proof generation only). Our goal is to release an efficient and easy to use service that can be used by any application that builds atop of MACI.
+
+## 3) Integration with DAO's tooling provider
+
+As an effort to support DAO governance, and help solve their issues with bribery and collusion, MACI is focusing on integrating with DAO's tooling providers.
+
+To start with, MACI is integrating with [Aragon](https://aragon.org/) by building a voting [plugin](https://github.com/privacy-scaling-explorations/maci-voting-plugin).
+
+In the future, we plan to continue working with other partners such as [Agora](https://www.agora.xyz/), and help them offer DAOs secure and private voting.
+
+## 4) Coordinator decentralisation
+
+It's no secret that one of MACI long standing issues has having a centralised coordinator. They are able to see all of the votes in cleartext, which allows them to collude with bribers themselves, as well as voters. As we look to tackle use cases such as DAO governance where large quantities of money are involved in proposals, we need to ensure that collusion between the coordinator and voters/bribers is reduced. This can be accomplished in several ways:
+
+- Use Multi Party Computation (MPC)
+- Use Homomorphic Encryption (HE)
+- Use a Trusted Execution Environment (TEE)
+
+We plan to research the best approach and start the implementation within the year.
+
+## Future R&D
+
+While not prioritized as an upcoming workstream, we think it’s worth calling out important areas of research & development that we’re excited to work on in the future:
+
+### MACI improvements
+
+- Scaling explorations, like SNARK Folding Schemes (e.g. [Nova integration](https://github.com/privacy-scaling-explorations/maci/issues/904))
+- Different matching mechanisms (e.g. [Group Wise Matching in Quadratic Funding](https://github.com/privacy-scaling-explorations/maci/issues/905))
+- Re-implementation of previously removed features such as [Topup](https://github.com/privacy-scaling-explorations/maci/issues/1384) and [Subsidy](https://github.com/privacy-scaling-explorations/maci/issues/1348)
+- [Benchmarks](https://github.com/privacy-scaling-explorations/maci/issues/1197) for the whole stack
+
+## Feedback
+
+Questions? Concerns? Ideas? We’d love to hear from you!
+
+Feel free to [create an issue on our GitHub](https://github.com/privacy-scaling-explorations/maci/issues) or reach out to our team in the [PSE Discord](https://discord.com/invite/sF5CT5rzrR) (`#maci` channel).

package/src/pages/typedoc.tsx

@@ -0,0 +1,11 @@
+import Layout from "@theme/Layout";
+
+import type { ReactElement } from "react";
+
+const TypedocPage = (): ReactElement => (
+  <Layout description="Description for your Typedoc page" title="Typedoc">
+    <iframe src="/typedoc_output/index.html" style={{ width: "100%", height: "100vh" }} title="typedoc" />
+  </Layout>
+);
+
+export default TypedocPage;

package/src/plugins/blog-plugin/index.ts

@@ -0,0 +1,86 @@
+import matter from "gray-matter";
+
+import fs from "fs";
+import path from "path";
+
+import type { Plugin as DocusaurusPlugin } from "@docusaurus/types";
+
+interface BlogPost {
+  title: string;
+  date: string;
+  slug: string;
+  description: string;
+  authorName: string;
+  tags: string[];
+  excerpt: string;
+}
+
+async function getAllFiles(dirPath: string, arrayOfFiles: string[] = []): Promise<string[]> {
+  const files = await fs.promises.readdir(dirPath);
+
+  const filePromises = files.map(async (file) => {
+    const filePath = path.join(dirPath, file);
+    const stat = await fs.promises.stat(filePath);
+
+    if (stat.isDirectory()) {
+      await getAllFiles(filePath, arrayOfFiles);
+    } else {
+      arrayOfFiles.push(filePath);
+    }
+  });
+
+  await Promise.all(filePromises);
+  return arrayOfFiles;
+}
+
+export { getAllFiles };
+
+async function loadContent(): Promise<BlogPost[]> {
+  const blogDir = path.join(__dirname, "..", "..", "..", "blog");
+  const files = await getAllFiles(blogDir);
+
+  const posts = (
+    await Promise.all(
+      files.map(async (filePath): Promise<BlogPost | null> => {
+        const fileContent = await fs.promises.readFile(filePath, "utf-8");
+        const { data } = matter(fileContent);
+
+        if (!data.title) {
+          return null;
+        }
+
+        const filename = path.basename(filePath);
+        const match = filename.match(/^(\d{4}-\d{2}-\d{2})/);
+        if (!match) {
+          return null;
+        }
+
+        const date = match[1];
+        const authorName = ((data.authors as Record<string, unknown> | undefined)?.name as string) || "";
+
+        return {
+          title: data.title as string,
+          description: data.description ? (data.description as string) : "",
+          date,
+          slug: data.slug ? (data.slug as string) : filename.replace(/\.md$/, ""), // Use slug from front matter if available
+          authorName,
+          tags: data.tags ? (data.tags as string[]) : [],
+          excerpt: data.excerpt ? (data.excerpt as string) : "",
+        };
+      }),
+    )
+  ).filter((post): post is BlogPost => post !== null);
+
+  // Sort posts by date in descending order (newest first)
+  posts.sort((a, b) => new Date(b.date).getTime() - new Date(a.date).getTime());
+
+  return posts;
+}
+
+export { loadContent };
+
+export default function blogPlugin(): DocusaurusPlugin<undefined> {
+  return {
+    name: "blog-plugin",
+  };
+}

package/src/react-app-env.d.ts

@@ -0,0 +1 @@
+declare module "*.png";

package/src/scripts/setupSolidityDocs.ts

@@ -0,0 +1,67 @@
+import fs from "fs";
+import path from "path";
+
+import { copyDirectory, generateToC, insertIndexPage } from "./utils";
+
+// where to move the solidity doc files over
+const solidityDocDir = path.resolve(
+  __dirname,
+  "../../versioned_docs/version-v3.x/technical-references/smart-contracts/solidity-docs",
+);
+// the origin folder (from the contracts package)
+const sourceDir = path.resolve(__dirname, "../../../../packages/contracts/docs");
+
+/**
+ * Currently, Solidity docgen generates the same heading for all files.
+ * We need to remove it and add the contract name as a heading.
+ * @param dir - the directory where the documentation files are located
+ */
+function updateHeadings(dir: string) {
+  const files = fs.readdirSync(dir);
+
+  files.forEach((file: string) => {
+    const absolutePath = path.join(dir, file);
+    const isDirectory = fs.statSync(absolutePath).isDirectory();
+
+    if (isDirectory) {
+      insertIndexPage(
+        absolutePath,
+        { title: file, label: file },
+        `
+          Documentation for smart contracts inside the ${file} folder.\n
+          ${generateToC(absolutePath)}\n
+        `,
+      );
+      updateHeadings(absolutePath);
+    } else {
+      // Read the content of the file
+      let fileContent = fs.readFileSync(absolutePath, "utf8");
+
+      // Remove the "# Solidity API" line
+      fileContent = fileContent.replace("# Solidity API\n", "");
+
+      // Replace the first "##" with "#"
+      fileContent = fileContent.replace("##", "#");
+
+      // Escape {...} by wrapping them in backticks
+      fileContent = fileContent.replace(/{(.*?)}/g, "`{$1}`");
+
+      // Write the modified content back to the file
+      fs.writeFileSync(absolutePath, fileContent, "utf8");
+    }
+  });
+}
+
+// copy over the directory
+copyDirectory(sourceDir, solidityDocDir);
+// update the headings
+updateHeadings(solidityDocDir);
+// insert index page
+insertIndexPage(
+  solidityDocDir,
+  {
+    title: "Solidity Docs",
+    label: "Solidity Docs",
+  },
+  "This is a collection of the Solidity documentation for the MACI protocol. It is autogenerated with solidity-docs and should serve as a good starting point for understanding the codebase.",
+);