Skip to main content

Architecture Overview

This page describes the current technical architecture for the SustainaSeed Knowledge Base.

Current Stack​

The knowledge base uses:

  • Docusaurus for the documentation website
  • GitHub for source control
  • GitHub Actions for automated build and deployment
  • Firebase Hosting for static site hosting
  • Google Drive for non-technical content intake

Live Site​

The live wiki is hosted at:

https://sustainaseed-kb.web.app

Source Repository​

The source repository is:

https://github.com/sustainaseed-product/sustainaseed-kb

Deployment Flow​

The deployment flow is:

  1. A maintainer commits Markdown files to the main branch.
  2. GitHub Actions installs dependencies.
  3. Docusaurus builds the static site.
  4. Firebase CLI deploys the build output to Firebase Hosting.
  5. The live wiki updates automatically.

Authentication for Deployment​

GitHub Actions deploys to Firebase using Google Workload Identity Federation.

This avoids storing service account JSON keys in GitHub.

warning

Do not create or commit service account JSON keys.

Content Flow​

The content flow is:

  1. Non-technical contributors submit Google Docs.
  2. Rakesh or Josh reviews the content.
  3. Approved content is converted to Markdown.
  4. Markdown is added under docs/.
  5. GitHub Actions publishes the wiki.

Cost Control​

The current architecture is designed to remain low-cost by avoiding:

  • Cloud Functions
  • Cloud Run
  • Cloud SQL
  • Large file hosting
  • Paid search services
  • Heavy database usage

Large files should remain in Google Drive and be linked from wiki pages only when appropriate.