How sui-foundation/sips works
Project type and purpose
• This repository is a documentation/content project: a set of “Sui Improvement Proposals” (SIPs) written in Markdown, organized into active and withdrawn proposals with accompanying assets.
• Its purpose is to serve as the source of truth for design documents that get rendered into a public-facing site (https://sips.sui.io).
File structure
• Top level:
• .gitignore, CONTRIBUTING.md, LICENSE.md, README.md, TEMPLATE.md
• assets/ (images or other media keyed by SIP number)
• sips/ (active proposal .md files)
• withdrawn-sips/ (archived proposal .md files + its own README)
• No code modules or build scripts in this repo—content is likely consumed by a static site generator or documentation pipeline.
README for additional insights
• Defines what a SIP is and points to contribution guidelines.
• Mentions external discussion URLs for comments.
• No explicit build/deploy instructions—implies a standard Markdown-to-HTML pipeline (e.g. Next.js, Docusaurus, MkDocs).
a. Main components:
1. Content Repository (GitHub)
2. CI/CD Pipeline (e.g., GitHub Actions)
3. Static Site Generator (e.g., Docusaurus/Next.js)
4. CDN or Hosting Platform (e.g., Netlify, Vercel, GitHub Pages)
5. End-User Browser Interface (website UI)
6. External Discussion Services (e.g., Discourse or sips.sui.io/comments)
b. Relationships & interactions:
– Developer pushes Markdown files → GitHub repo
– CI/CD picks up changes → runs build (Markdown → HTML)
– Deployment step → publishes static assets to CDN/hosting
– CDN serves content to user browsers
– UI includes “discuss” links to external comment platform
c. Architectural patterns/design principles:
– Content-centric (Headless CMS style)
– Static site generation (SSG)
– Separation of concerns: content vs build vs hosting vs discussions
d. Key technologies/frameworks:
– GitHub for version control & PR workflow
– GitHub Actions (or similar) for automated build & deploy
– Static site generator (e.g., Docusaurus/Next.js) reading Markdown from sips/ and withdrawn-sips/
– CDN (Netlify/Vercel/GH Pages) for asset distribution
– External commenting system (sips.sui.io or Discourse)