From 0f30fa7d0350f201a6ba8047975544674ab402d6 Mon Sep 17 00:00:00 2001 From: Robbert Schep Date: Wed, 16 Jul 2025 00:02:25 +0200 Subject: [PATCH] added styleguide for consistent content creation --- docs/0_timeline/the-experiment.md | 7 + docs/_snippets/.pages | 1 + docs/_snippets/join-cta.md | 29 + docs/_snippets/phase-indicator.md | 5 + docs/_snippets/readme.md | 3 + docs/_snippets/status-card.md | 27 + docs/_snippets/team-card.md | 14 + docs/_templates/.pages | 1 + docs/_templates/README.md | 30 + docs/_templates/page-template.md | 20 + docs/_templates/phase-page.md | 84 + docs/_templates/team-page.md | 87 + docs/_templates/team-template.md | 16 + docs/style-guide.md | 733 ++++++ docs/stylesheets/extra.css | 12 + mkdocs.yml | 14 +- readme.md | 18 + site/0_timeline/history/index.html | 101 +- site/0_timeline/the-experiment/index.html | 111 +- site/0_timeline/the-observation/index.html | 101 +- .../the-smartup-hypothesis/index.html | 101 +- site/404.html | 101 +- site/_snippets/join-cta/index.html | 800 ++++++ site/_snippets/phase-indicator/index.html | 770 ++++++ site/_snippets/readme/index.html | 786 ++++++ site/_snippets/status-card/index.html | 785 ++++++ site/_snippets/team-card/index.html | 798 ++++++ site/_templates/index.html | 824 ++++++ site/_templates/page-template/index.html | 821 ++++++ site/_templates/phase-page/index.html | 933 +++++++ site/_templates/team-page/index.html | 1038 ++++++++ site/_templates/team-template/index.html | 799 ++++++ site/index.html | 109 +- site/search/search_index.json | 2 +- site/sitemap.xml | 66 +- site/sitemap.xml.gz | Bin 297 -> 382 bytes site/smartup-zero/1_general_forum/index.html | 101 +- site/smartup-zero/2_workplace/index.html | 101 +- site/smartup-zero/3_teams/index.html | 101 +- site/smartup-zero/4_roles/index.html | 101 +- site/smartup-zero/5_objectives/index.html | 101 +- site/smartup-zero/6_tasks/index.html | 103 +- site/style-guide/index.html | 2321 +++++++++++++++++ site/stylesheets/extra.css | 12 + 44 files changed, 13042 insertions(+), 46 deletions(-) create mode 100644 docs/_snippets/.pages create mode 100644 docs/_snippets/join-cta.md create mode 100644 docs/_snippets/phase-indicator.md create mode 100644 docs/_snippets/readme.md create mode 100644 docs/_snippets/status-card.md create mode 100644 docs/_snippets/team-card.md create mode 100644 docs/_templates/.pages create mode 100644 docs/_templates/README.md create mode 100644 docs/_templates/page-template.md create mode 100644 docs/_templates/phase-page.md create mode 100644 docs/_templates/team-page.md create mode 100644 docs/_templates/team-template.md create mode 100644 docs/style-guide.md create mode 100644 site/_snippets/join-cta/index.html create mode 100644 site/_snippets/phase-indicator/index.html create mode 100644 site/_snippets/readme/index.html create mode 100644 site/_snippets/status-card/index.html create mode 100644 site/_snippets/team-card/index.html create mode 100644 site/_templates/index.html create mode 100644 site/_templates/page-template/index.html create mode 100644 site/_templates/phase-page/index.html create mode 100644 site/_templates/team-page/index.html create mode 100644 site/_templates/team-template/index.html create mode 100644 site/style-guide/index.html diff --git a/docs/0_timeline/the-experiment.md b/docs/0_timeline/the-experiment.md index e69de29..a4f7508 100644 --- a/docs/0_timeline/the-experiment.md +++ b/docs/0_timeline/the-experiment.md @@ -0,0 +1,7 @@ +**Smartup Zero** is an experiment to validate a radically transparent, democratic, public-good technology incubation modelβ€”"the Smartup Model"β€”with ONLIFE as its flagship project. The goal is to produce a resilient, open, mission-driven tech for the common good, addressing the limitations of traditional, venture-funded innovation pathways. + +- **ONLIFE:** The technical product (EU-wide mesh emergency network). +- **Smartup:** The organizational β€œoperating system” (collective ownership, governance, credits). +- **Smartup Zero:** The first real-world test/project for this model. +- **0_timeline.org:** Proposed as the living, up-to-date window and onboarding entry to Smartup experiments/projects. + diff --git a/docs/_snippets/.pages b/docs/_snippets/.pages new file mode 100644 index 0000000..e2d5ae9 --- /dev/null +++ b/docs/_snippets/.pages @@ -0,0 +1 @@ +hide: true diff --git a/docs/_snippets/join-cta.md b/docs/_snippets/join-cta.md new file mode 100644 index 0000000..de15130 --- /dev/null +++ b/docs/_snippets/join-cta.md @@ -0,0 +1,29 @@ +## :material-rocket-launch: Ready to Contribute? + +
+ +:material-account-plus:{ .lg } + +**Join the Project** + +Become a Smartup Zero owner + +[Join via Open Collective :material-open-in-new:](https://opencollective.com/smartup-zero){ .md-button } + +:material-chat:{ .lg } + +**Start Discussing** + +Connect with the community + +[Enter Matrix Space :material-open-in-new:](https://matrix.to/#/#smartup-zero:matrix.org){ .md-button } + +:material-hammer:{ .lg } + +**Start Building** + +Pick up your first task + +[Browse Open Tasks :material-open-in-new:](https://smartup-zero-forgejo.fly.dev/smartup-zero/){ .md-button } + +
diff --git a/docs/_snippets/phase-indicator.md b/docs/_snippets/phase-indicator.md new file mode 100644 index 0000000..c2ac1b7 --- /dev/null +++ b/docs/_snippets/phase-indicator.md @@ -0,0 +1,5 @@ +!!! success inline end "Phase Status" + **Status:** Active + **Duration:** 30 days + **Started:** January 1, 2025 + **Target End:** January 31, 2025 diff --git a/docs/_snippets/readme.md b/docs/_snippets/readme.md new file mode 100644 index 0000000..b6051d3 --- /dev/null +++ b/docs/_snippets/readme.md @@ -0,0 +1,3 @@ +status card: This snippet can be included in any page using: + +--8<-- "_snippets/status-card.md" diff --git a/docs/_snippets/status-card.md b/docs/_snippets/status-card.md new file mode 100644 index 0000000..fd1d3df --- /dev/null +++ b/docs/_snippets/status-card.md @@ -0,0 +1,27 @@ +
+ +- :material-check-circle:{ .lg .middle } **Completed** + + --- + + [Description of completed item] + + [:octicons-arrow-right-24: View details](#) + +- :material-progress-clock:{ .lg .middle } **In Progress** + + --- + + [Description of in-progress item] + + [:octicons-arrow-right-24: Track progress](#) + +- :material-calendar-clock:{ .lg .middle } **Planned** + + --- + + [Description of planned item] + + [:octicons-arrow-right-24: See roadmap](#) + +
diff --git a/docs/_snippets/team-card.md b/docs/_snippets/team-card.md new file mode 100644 index 0000000..73e6259 --- /dev/null +++ b/docs/_snippets/team-card.md @@ -0,0 +1,14 @@ +### :material-account-group: Team Name + +!!! tip inline end "Quick Links" + :material-git: [Repos](https://smartup-zero-forgejo.fly.dev/) + :material-chat: [Chat](#) + :material-clipboard-list: [Tasks](#) + +**Captain:** [@username](#) +**Members:** 5 active +**Mission:** One-line mission statement + +**Current Focus:** +- Current objective 1 +- Current objective 2 diff --git a/docs/_templates/.pages b/docs/_templates/.pages new file mode 100644 index 0000000..e2d5ae9 --- /dev/null +++ b/docs/_templates/.pages @@ -0,0 +1 @@ +hide: true diff --git a/docs/_templates/README.md b/docs/_templates/README.md new file mode 100644 index 0000000..425c5d4 --- /dev/null +++ b/docs/_templates/README.md @@ -0,0 +1,30 @@ +# πŸ“‹ Smartup Zero Content Templates + +This directory contains templates for common page types. Using these templates ensures consistency across all documentation. + +## Available Templates + +### πŸ“… phase-page.md +Use this template when documenting project phases. + +**Usage:** +```bash +cp docs/_templates/phase-page.md docs/0_timeline/phases/phase-0-micropilot.md +# Then edit to fill in the [placeholders] +When to use: + +Documenting any of the 4 phases (Validation, Design, Production, Organization) +Creating phase-specific status pages +Planning future phases +How to Use Templates +Copy the template to your target location +Replace all [placeholder] text with actual content +Remove any sections that aren't relevant +Follow the style guide for formatting +Creating New Templates +When creating new templates: + +Use clear placeholders in [Square Brackets] +Include all standard components from the style guide +Add usage instructions to this README +Test the template by creating a sample page diff --git a/docs/_templates/page-template.md b/docs/_templates/page-template.md new file mode 100644 index 0000000..1039bca --- /dev/null +++ b/docs/_templates/page-template.md @@ -0,0 +1,20 @@ +# :material-icon: Page Title + +!!! info "What is this?" + One-sentence explanation of what this page covers. + +## Purpose + +Brief paragraph explaining why this matters in the Smartup Zero context. + +## Main Content + +Your content here... + +## :material-rocket-launch: Next Steps + +What the reader should do after reading this page. + +!!! seealso "Related Topics" + - [Related Page 1](link) + - [Related Page 2](link) diff --git a/docs/_templates/phase-page.md b/docs/_templates/phase-page.md new file mode 100644 index 0000000..c1f7045 --- /dev/null +++ b/docs/_templates/phase-page.md @@ -0,0 +1,84 @@ +# :material-numeric-[X]-circle: Phase [Number]: [Phase Name] + +!!! info "What is this?" + This page documents Phase [Number] of the Smartup Zero experiment, including goals, timeline, and deliverables. + +## Overview + +!!! success inline end "Phase Status" + **Status:** [Not Started/Active/Complete] + **Duration:** [X] days + **Started:** [Date or TBD] + **Target End:** [Date or TBD] + **Actual End:** [Date or TBD] + +[Brief description of what this phase is about and why it's important] + +## Goals & Success Criteria + +### Primary Goals + +- [ ] **Goal 1:** [Specific, measurable goal] + - Success metric: [How we measure completion] + - Current status: [Progress update] + +- [ ] **Goal 2:** [Specific, measurable goal] + - Success metric: [How we measure completion] + - Current status: [Progress update] + +### Deliverables + +| Deliverable | Description | Owner | Status | +|-------------|-------------|-------|---------| +| [Name] | [What it is] | @team/person | :material-check: Done | +| [Name] | [What it is] | @team/person | :material-progress-wrench: In Progress | +| [Name] | [What it is] | @team/person | :material-calendar: Planned | + +## Timeline + +```mermaid +gantt + title Phase [Number] Timeline + dateFormat YYYY-MM-DD + section Preparation + [Task 1] :2025-01-01, 7d + section Development + [Task 2] :7d + [Task 3] :7d + section Review + [Task 4] :3d +Budget & Resources +Financial Requirements +Target Funding: €[Amount] +Raised: €[Amount] +Burn Rate: €[Amount]/month +Human Resources +Contributors Needed: [Number] +Current Team Size: [Number] +Key Roles to Fill: [List] +Key Decisions & Gates +!!! warning "Phase Gate Requirements" +Before proceeding to the next phase, we must: + +text +1. Achieve financial target of €[Amount] +2. Complete all primary deliverables +3. Pass scientific review (if applicable) +4. **Hold binding vote to proceed** +Lessons Learned +??? info "Insights from this phase" +Document key learnings as the phase progresses: + +text +- What worked well +- What didn't work +- What we'd do differently +- Recommendations for future phases + + +Related Documents +Previous Phase +Next Phase +Overall Experiment +Project Timeline + diff --git a/docs/_templates/team-page.md b/docs/_templates/team-page.md new file mode 100644 index 0000000..63e7b0e --- /dev/null +++ b/docs/_templates/team-page.md @@ -0,0 +1,87 @@ +# :material-account-group: [Team Name] Team + +!!! info "What is this?" + This page describes the [Team Name] team's mission, members, and current work. + +## Purpose + +[Explain why this team exists and what unique value it brings to Smartup Zero] + +## Team Structure + +!!! tip inline end "Quick Links" + :material-git: [Team Repos](https://smartup-zero-forgejo.fly.dev/smartup-zero/[team-name]) + :material-chat: [Team Room](#3_[team-name]) + :material-clipboard-list: [Open Tasks](link) + +**Captain:** [@username](link) +**Members:** X active contributors +**Formed:** [Month Year] + +### Team Members + +| Member | Role | Joined | Specialties | +|--------|------|--------|-------------| +| @captain | Team Captain | Jan 2025 | Leadership, [Skill] | +| @member1 | [Role] | Jan 2025 | [Skills] | +| @member2 | [Role] | Jan 2025 | [Skills] | + +## Mission Statement + +[One clear paragraph describing what this team is responsible for] + +## Current Objectives + +### :material-target: Active Objectives + +1. **[Objective Name]** (Due: [Date]) + - Description of what needs to be achieved + - Key deliverable + - Success metrics + +2. **[Objective Name]** (Due: [Date]) + - Description of what needs to be achieved + - Key deliverable + - Success metrics + +### :material-check-circle: Completed Objectives + +??? success "View completed work" + - [Objective] - Completed [Date] + - [Objective] - Completed [Date] + +## How We Work + +### Communication +- **Primary Channel:** Element room `#3_[team-name]` +- **Meetings:** [Frequency] at [Time] UTC +- **Decisions:** Made by consensus, escalated to captain if needed + +### Contribution Process +1. Check open tasks in our [project board](link) +2. Comment on task to claim it +3. Submit PR when complete +4. Captain or designated reviewer approves + +## Resources + +### Documentation +- [Team handbook](link) +- [Technical guidelines](link) +- [Best practices](link) + +### Tools +- [Tool 1] - Purpose +- [Tool 2] - Purpose + +## Join Our Team + +Interested in joining the [Team Name] team? Here's how: + +1. Join the [General Forum](../1_general_forum.md) +2. Introduce yourself in our team room +3. Pick up a "good first task" +4. Attend our next team meeting + +!!! question "Questions?" + Reach out to our captain @captain in Element diff --git a/docs/_templates/team-template.md b/docs/_templates/team-template.md new file mode 100644 index 0000000..e8adf2c --- /dev/null +++ b/docs/_templates/team-template.md @@ -0,0 +1,16 @@ +### :material-account-group: Team Name + +!!! tip inline end "Quick Links" + :material-git: [Team Repos](https://smartup-zero-forgejo.fly.dev/smartup-zero/team-name) + :material-chat: [Team Room](#3_team-name) + :material-clipboard-list: [Open Tasks](link) + +**Captain:** [@username](link) +**Members:** X active contributors +**Formed:** Month Year + +**Mission:** One clear sentence describing the team's purpose. + +**Current Objectives:** +- Objective 1 with deadline +- Objective 2 with deadline diff --git a/docs/style-guide.md b/docs/style-guide.md new file mode 100644 index 0000000..42a7a67 --- /dev/null +++ b/docs/style-guide.md @@ -0,0 +1,733 @@ +# πŸ“– 0_timeline Content Style Guide + +!!! info "Purpose" + This guide ensures consistent content across the 0_timeline website. All contributors should reference this when creating or editing content. Our goal is to make complex ideas accessible while maintaining the experimental, transparent spirit of Smartup Zero. + +## 🎨 Visual Language + +### Icon Dictionary + +Always use these icons for consistency across all pages: + +| Concept | Icon Code | Usage | Preview | +|---------|-----------|--------|---------| +| **Organizational Structure** | +| General Forum | `:material-forum:` | Public discussions, voting, governance | :material-forum: | +| Workplace | `:material-briefcase:` | Worker-only spaces and content | :material-briefcase: | +| Teams | `:material-account-group:` | Team-related content | :material-account-group: | +| Roles | `:material-card-account-details:` | Role definitions and assignments | :material-card-account-details: | +| Objectives | `:material-target:` | Project goals and missions | :material-target: | +| Tasks | `:material-checkbox-marked-circle:` | Individual work items | :material-checkbox-marked-circle: | +| **Project Specifics** | +| ONLIFE | `:material-alert-decagram:` | Emergency network references | :material-alert-decagram: | +| Smartup Model | `:material-atom:` | Core model concepts | :material-atom: | +| Experiment | `:material-flask:` | Scientific method references | :material-flask: | +| **Actions & States** | +| Vote | `:material-vote:` | Governance decisions | :material-vote: | +| Join | `:material-account-plus:` | Recruitment/onboarding | :material-account-plus: | +| Build | `:material-hammer:` | Development work | :material-hammer: | +| Success | `:material-check-circle:` | Completed/positive items | :material-check-circle: | +| Warning | `:material-alert:` | Important notices | :material-alert: | +| Info | `:material-information:` | Explanations | :material-information: | +| **Financial** | +| Treasury | `:material-currency-eur:` | Money/funding matters | :material-currency-eur: | +| Credits | `:material-coin:` | Smartup Credits (SC) | :material-hand-coin: | +| **Technical** | +| Code | `:material-code-tags:` | Development/repos | :material-code-tags: | +| Infrastructure | `:material-server:` | Technical stack | :material-server: | +| Communication | `:material-chat:` | Matrix/Element | :material-chat: | + +### Color Philosophy + +- **Primary (Amber)** 🟨: Energy, innovation, warmth - use for main CTAs and highlights +- **Accent (Lime)** 🟩: Growth, freshness, progress - use for success states and secondary actions +- **Semantic Colors**: Use mkdocs-material's built-in admonition colors for meaning + +## πŸ“ Content Patterns + +### Page Headers + +Every page should start with a clear hierarchy. + +**Example Code:** +~~~markdown +###:material-forum: Our General Forum + +!!! info "What is this?" + The public square for all Smartup Zero owners where governance happens. + +### Purpose + +This is where we make collective decisions that shape our project's future. +~~~ + +**Renders as:** + +###:material-forum: Our General Forum + +!!! info "What is this?" + The public square for all Smartup Zero owners where governance happens. + +**Purpos**e + +This is where we make collective decisions that shape our project's future. + + +### Status Indicators + +For showing project or phase status. + +**Example Code:** +~~~markdown +
+ +- :material-check-circle:{ .lg .middle } **Infrastructure** + + --- + + Core services deployed and operational + + [:octicons-arrow-right-24: View details](#) + +- :material-progress-clock:{ .lg .middle } **ONLIFE Development** + + --- + + Building the MVP emergency network + + [:octicons-arrow-right-24: Track progress](#) + +- :material-calendar-clock:{ .lg .middle } **First Funding** + + --- + + Crowdfunding campaign preparation + + [:octicons-arrow-right-24: See timeline](#) + +
+~~~ + +**Renders as:** + +
+ +- :material-check-circle:{ .lg .middle } **Infrastructure** + + --- + + Core services deployed and operational + + [:octicons-arrow-right-24: View details](#) + +- :material-progress-clock:{ .lg .middle } **ONLIFE Development** + + --- + + Building the MVP emergency network + + [:octicons-arrow-right-24: Track progress](#) + +- :material-calendar-clock:{ .lg .middle } **First Funding** + + --- + + Crowdfunding campaign preparation + + [:octicons-arrow-right-24: See timeline](#) + +
+ +--- + +### Team Cards + +Standard format for presenting teams. + +**Example Code:** +~~~markdown +**:material-account-group: Development Team** + + + +**Captain:** [@alice](https://matrix.to/#/@alice:matrix.org) +**Members:** 5 active contributors +**Formed:** January 2025 + +**Mission:** Build the ONLIFE emergency communication protocol and apps. + +**Current Objectives:** +- Complete Android MVP by Feb 28 +- Implement mesh networking core +~~~ + +**Renders as:** + +**:material-account-group: Development Team** + + + +**Captain:** [@alice](https://matrix.to/#/@alice:matrix.org) +**Members:** 5 active contributors +**Formed:** January 2025 + +**Mission:** Build the ONLIFE emergency communication protocol and apps. + +**Current Objectives:** +- Complete Android MVP by Feb 28 +- Implement mesh networking core + +--- + +### Phase Documentation + +For describing project phases. + +**Example Code:** +~~~markdown +**:material-numeric-0-circle: Phase 0: Micro-Pilot** + + + +**Goals for This Phase** + +- [x] Deploy core infrastructure +- [ ] Onboard 15-20 contributors +- [ ] Complete one full work cycle + +**Key Deliverables** + +| Deliverable | Description | Status | +|-------------|-------------|---------| +| Tech Stack | Forgejo + Matrix deployed | :material-check: Done | +| Engelbot | Automation bot v0.1 | :material-progress-wrench: In Progress | +| First Task | Test the SC system | :material-calendar: Planned | +~~~ + +**Renders as:** + +**:material-numeric-0-circle: Phase 0: Micro-Pilot** + +!!! info inline end "Phase Status" + **Status:** Active + **Duration:** 30 days + **Started:** Jan 1, 2025 + **Target:** Jan 31, 2025 + +**Goals for This Phase** + +- [x] Deploy core infrastructure +- [ ] Onboard 15-20 contributors +- [ ] Complete one full work cycle + +**Key Deliverables** + +| Deliverable | Description | Status | +|-------------|-------------|---------| +| Tech Stack | Forgejo + Matrix deployed | :material-check: Done | +| Engelbot | Automation bot v0.1 | :material-progress-wrench: In Progress | +| First Task | Test the SC system | :material-calendar: Planned | + +--- + +### Call-to-Action Sections + +For encouraging participation. + +**Example Code:** +~~~markdown +**:material-rocket-launch: Ready to Contribute?** + +
+ +:material-account-plus:{ .lg } + +**Join the Project** + +Become a Smartup Zero owner + +[Join via Open Collective :material-open-in-new:](https://opencollective.com/smartup-zero){ .md-button } + +:material-chat:{ .lg } + +**Start Discussing** + +Connect with the community + +[Enter Matrix Space :material-open-in-new:](#){ .md-button } + +:material-hammer:{ .lg } + +**Start Building** + +Pick up your first task + +[Browse Open Tasks :material-open-in-new:](#){ .md-button } + +
+~~~ + +**Renders as:** + +**:material-rocket-launch: Ready to Contribute?** + +
+ +:material-account-plus:{ .lg } + +**Join the Project** + +Become a Smartup Zero owner + +[Join via Open Collective :material-open-in-new:](https://opencollective.com/smartup-zero){ .md-button } + +:material-chat:{ .lg } + +**Start Discussing** + +Connect with the community + +[Enter Matrix Space :material-open-in-new:](#){ .md-button } + +:material-hammer:{ .lg } + +**Start Building** + +Pick up your first task + +[Browse Open Tasks :material-open-in-new:](#){ .md-button } + +
+ +## πŸ“ Writing Guidelines + +### Voice & Tone + +- **Inclusive**: Always "we" not "I" or "they" +- **Experimental**: Acknowledge we're learning ("we believe", "our hypothesis") +- **Transparent**: Share both successes and challenges +- **Accessible**: Explain technical terms on first use + +### Structure Guidelines + +1. **Start with Why**: Lead with purpose/problem before solution +2. **Show, Don't Just Tell**: Use examples and diagrams +3. **Progressive Disclosure**: Overview first, details in expandable sections + +**Example Code:** +~~~markdown +** The Smartup Credit System + +**Why it exists:** We need a fair way to track and reward contributions before cash arrives. + +??? info "How it works (Technical Details)" + When a contributor completes a task, the Team Captain approves it and + Smartup Credits are minted to the ledger. These credits represent a + future claim on treasury funds at a 1 SC = 1 EUR rate. +~~~ + +**Renders as:** + +**The Smartup Credit System** + +**Why it exists:** We need a fair way to track and reward contributions before cash arrives. + +??? info "How it works (Technical Details)" + When a contributor completes a task, the Team Captain approves it and + Smartup Credits are minted to the ledger. These credits represent a + future claim on treasury funds at a 1 SC = 1 EUR rate. + +### Common Phrases + +Use these standardized phrases: + +- "Smartup Zero" (not "SmartUp" or "smartup") +- "Smartup Credits (SC)" on first mention, then "SC" +- "the experiment" (lowercase when referring to our project) +- "collective ownership/craftsmanship/governance" (our three pillars) +- "ONLIFE" (all caps - it's an acronym) + +## 🧩 Component Library + +### Definition Boxes + +**Example Code:** +~~~markdown +!!! info "Smartup" + A new organizational model based on collective ownership, collective + craftsmanship, and collective governance. +~~~ + +**Renders as:** + +!!! info "Smartup" + A new organizational model based on collective ownership, collective + craftsmanship, and collective governance. + +--- + +### Warning Boxes + +**Example Code:** +~~~markdown +!!! warning "Experimental Phase" + This process is still being tested in our micro-pilot. + Procedures may change based on learnings. +~~~ + +**Renders as:** + +!!! warning "Experimental Phase" + This process is still being tested in our micro-pilot. + Procedures may change based on learnings. + +--- + +### Example Boxes + +**Example Code:** +~~~markdown +!!! example "How This Works in Practice" + When a developer completes a task worth 500 SC, the Team Captain + approves it, triggering an automatic ledger update via Engelbot. +~~~ + +**Renders as:** + +!!! example "How This Works in Practice" + When a developer completes a task worth 500 SC, the Team Captain + approves it, triggering an automatic ledger update via Engelbot. + +--- + +### Quote Boxes + +**Example Code:** +~~~markdown +!!! quote "Our Inscription" + We don't accept our reality but seek to alter it. We are not too late + or too early but precisely on time. The next big thing will be a mosaic + of small things. +~~~ + +**Renders as:** + +!!! quote "Our Inscription" + We don't accept our reality but seek to alter it. We are not too late + or too early but precisely on time. The next big thing will be a mosaic + of small things. + +--- + +### Tabs for Multiple Perspectives + +**Example Code:** +~~~markdown +=== ":material-account: For Contributors" + + Learn how to join the project and start earning Smartup Credits + by contributing your skills to building ONLIFE. + +=== ":material-currency-eur: For Supporters" + + Discover how your financial support directly enables the development + of public-good technology with transparent fund allocation. + +=== ":material-cellphone: For Future Users" + + Understand how ONLIFE will provide emergency communication when + traditional networks fail. +~~~ + +**Renders as:** + +=== ":material-account: For Contributors" + + Learn how to join the project and start earning Smartup Credits + by contributing your skills to building ONLIFE. + +=== ":material-currency-eur: For Supporters" + + Discover how your financial support directly enables the development + of public-good technology with transparent fund allocation. + +=== ":material-cellphone: For Future Users" + + Understand how ONLIFE will provide emergency communication when + traditional networks fail. + +--- + +### Expandable Details + +**Example Code:** +~~~markdown +??? question "What are Smartup Credits?" + + Smartup Credits (SC) are internal units that track contributions + before cash is available. 1 SC = 1 EUR claim on the treasury. + +??? tip "Pro Tip: Claiming Your First Task" + + Start with tasks labeled "good-first-task" in Forgejo. Comment + on the issue to claim it before starting work. +~~~ + +**Renders as:** + +??? question "What are Smartup Credits?" + + Smartup Credits (SC) are internal units that track contributions + before cash is available. 1 SC = 1 EUR claim on the treasury. + +??? tip "Pro Tip: Claiming Your First Task" + + Start with tasks labeled "good-first-task" in Forgejo. Comment + on the issue to claim it before starting work. + +--- + +### Button Styles + +**Example Code:** +~~~markdown +[Primary Action :material-arrow-right:](#){ .md-button .md-button--primary } +[Secondary Action](#){ .md-button } +[Text Link with Icon :material-open-in-new:](#) +~~~ + +**Renders as:** + +[Primary Action :material-arrow-right:](#){ .md-button .md-button--primary } +[Secondary Action](#){ .md-button } +[Text Link with Icon :material-open-in-new:](#) + +--- + +### Mermaid Diagrams + +**Example Code:** +~~~markdown +```mermaid +graph TD + A[Contributor] -->|Creates| B[Task] + B -->|Completes| C[Review] + C -->|Approves| D[SC Minted] + D -->|Logged in| E[Ledger] +``` +~~~ + +**Renders as:** + +```mermaid +graph TD + A[Contributor] -->|Creates| B[Task] + B -->|Completes| C[Review] + C -->|Approves| D[SC Minted] + D -->|Logged in| E[Ledger] +``` + +--- + +### Progress Indicators + +**Example Code:** +~~~markdown +!!! abstract "Micro-Pilot Progress" + :material-progress-check: **35% Complete** + + - [x] Infrastructure deployed + - [x] Core team assembled + - [ ] First work cycle + - [ ] Binding vote held +~~~ + +**Renders as:** + +!!! abstract "Micro-Pilot Progress" + :material-progress-check: **35% Complete** + + - [x] Infrastructure deployed + - [x] Core team assembled + - [ ] First work cycle + - [ ] Binding vote held + +## πŸ”§ Technical Formatting + +### Code Blocks + +Always specify language for syntax highlighting. + +**Example Code:** +~~~markdown +```python +def mint_credits(worker, amount): + """Mint Smartup Credits for completed work.""" + return ledger.add_entry(worker, amount) +``` +~~~ + +**Renders as:** + +```python +def mint_credits(worker, amount): + """Mint Smartup Credits for completed work.""" + return ledger.add_entry(worker, amount) +``` + +--- + +### File Contents + +**Example Code:** +~~~markdown +!!! example "ledger.log" + ```json + {"type": "mint", "worker": "@alice", "amount": 500, "task": "#42"} + ``` +~~~ + +**Renders as:** + +!!! example "ledger.log" + ```json + {"type": "mint", "worker": "@alice", "amount": 500, "task": "#42"} + ``` + +--- + +### Terminal Commands + +**Example Code:** +~~~markdown +```console +$ git clone https://smartup-zero-forgejo.fly.dev/smartup-zero/0_timeline.git +$ cd 0_timeline +$ mkdocs serve +INFO - Building documentation... +INFO - Documentation built in 2.43 seconds +``` +~~~ + +**Renders as:** + +```console +$ git clone https://smartup-zero-forgejo.fly.dev/smartup-zero/0_timeline.git +$ cd 0_timeline +$ mkdocs serve +INFO - Building documentation... +INFO - Documentation built in 2.43 seconds +``` + +## πŸ“Š Tables and Data + +### Standard Table Format + +**Example Code:** +~~~markdown +| Component | Status | Notes | +|-----------|--------|-------| +| Matrix Server | :material-check-circle: Operational | 99.9% uptime | +| Forgejo | :material-check-circle: Operational | v1.21.3 | +| Engelbot | :material-progress-wrench: In Progress | v0.1 pending | +~~~ + +**Renders as:** + +| Component | Status | Notes | +|-----------|--------|-------| +| Matrix Server | :material-check-circle: Operational | 99.9% uptime | +| Forgejo | :material-check-circle: Operational | v1.21.3 | +| Engelbot | :material-progress-wrench: In Progress | v0.1 pending | + +## 🌐 Linking Strategy + +### Internal Links + +- Use relative paths: `[Team Structure](../smartup-zero/3_teams.md)` +- Link to sections: `[Voting Process](1_general_forum.md#voting)` + +### External Links + +- Always add icon: `[Open Collective :material-open-in-new:](https://opencollective.com/smartup-zero)` +- Use descriptive text, not "click here" + +### Cross-References + +**Example Code:** +~~~markdown +!!! tip "Related Topics" + - [The Smartup Model](../0_timeline/the-smartup-hypothesis.md) + - [How to Contribute](../smartup-zero/2_workplace.md) + - [Team Structure](../smartup-zero/3_teams.md) +~~~ + +**Renders as:** + +!!! tip "Related Topics" + - [The Smartup Model](../0_timeline/the-smartup-hypothesis.md) + - [How to Contribute](../smartup-zero/2_workplace.md) + - [Team Structure](../smartup-zero/3_teams.md) + +### βœ… Checklist for New Pages + +Before publishing any new page, ensure: + +- [ ] Uses appropriate icon in title +- [ ] Has "What is this?" info box +- [ ] Follows voice & tone guidelines +- [ ] Includes at least one visual element (diagram, table, or card grid) +- [ ] Has clear CTAs if applicable +- [ ] Links to related content +- [ ] Uses consistent terminology +- [ ] Mobile-friendly (test grid layouts) + +## πŸš€ Quick Start Template + +Copy this template when creating new pages: + +~~~markdown +**:material-icon: Page Title + +!!! info "What is this?" + One-sentence explanation of what this page covers. + +**Purpose** + +Brief paragraph explaining why this matters in the Smartup Zero context. + +**Main Content** + +Your content here, following the patterns above... + +**:material-rocket-launch: Next Steps** + +What the reader should do after reading this page. + +!!! tip "Related Topics" + - [Related Page 1](link) + - [Related Page 2](link) +~~~ + +--- + +!!! success "Ready to Create Content!" + Now you have all the patterns and examples needed to create consistent, + beautiful content for 0_timeline. Remember to reference + this guide whenever you're unsure about formatting or style choices. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index f8b6d9a..6352251 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -178,3 +178,15 @@ body:not(.has-hero) .md-content__inner { padding-top: 3.5rem !important; /* Smaller header on mobile */ } } + +/* Force inline admonitions to work on desktop */ +@media screen and (min-width: 76.25em) { + .md-typeset .admonition.inline, + .md-typeset details.inline { + float: right; + margin-left: 1rem; + margin-top: 0; + max-width: 20rem; + } +} + diff --git a/mkdocs.yml b/mkdocs.yml index 905a9af..63ade63 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,6 +17,7 @@ theme: - navigation.expand - content.hero - toggle + - toc.follow logo: assets/smartup icon white.png favicon: assets/flavicon.png palette: @@ -48,11 +49,14 @@ markdown_extensions: emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.highlight - pymdownx.inlinehilite - - pymdownx.snippets + - pymdownx.snippets: + base_path: docs - pymdownx.keys - pymdownx.mark - pymdownx.blocks.caption - + - toc: + permalink: true + nav: - Home: index.md @@ -60,7 +64,7 @@ nav: - The Hypothesis: 0_timeline/the-smartup-hypothesis.md - The Experiment: 0_timeline/the-experiment.md - Project History: 0_timeline/history.md - - '---': '' # This creates a visual separator in the navigation + - '---': divider1 # This creates a visual separator in the navigation - 'Smartup Zero: The First Smartup - Building ONLIFE': - '1. Our General Forum': smartup-zero/1_general_forum.md - '2. Our Workplace': smartup-zero/2_workplace.md @@ -68,7 +72,9 @@ nav: - '4. Our Roles': smartup-zero/4_roles.md - '5. Our Objectives': smartup-zero/5_objectives.md - '6. Our Tasks': smartup-zero/6_tasks.md - + - '---': divider2 + - Contributing: + - 'Style Guide': style-guide.md plugins: - search - awesome-pages diff --git a/readme.md b/readme.md index 25cf56e..d42abbf 100644 --- a/readme.md +++ b/readme.md @@ -10,6 +10,24 @@ This repository contains the source code and deployment configuration for the [0 - **Official Smartup Business Plan (OSBP)**: Publishing the "why" and "what" of the project, derived from our community decisions. - **Recruitment Portal**: Displaying our team structure, open roles, and the process for joining the project. + +### Sitemap +```yaml +nav: + - Home: index.md + - The Observation: 0_timeline/the-observation.md + - The Hypothesis: 0_timeline/the-smartup-hypothesis.md + - The Experiment: 0_timeline/the-experiment.md + - Project History: 0_timeline/history.md + - '---': '' + - 'Smartup Zero: The First Smartup - Building ONLIFE': + - '1. Our General Forum': smartup-zero/1_general_forum.md + - '2. Our Workplace': smartup-zero/2_workplace.md + - '3. Our Teams': smartup-zero/3_teams.md + - '4. Our Roles': smartup-zero/4_roles.md + - '5. Our Objectives': smartup-zero/5_objectives.md + - '6. Our Tasks': smartup-zero/6_tasks.md + ## πŸ”§ Deployment Pipeline (How It Works) This project is automatically deployed to **Clever Cloud** on every push to the `master` branch. The process leverages Clever Cloud's **Python App Hosting** to achieve a fully automated build and deployment pipeline. diff --git a/site/0_timeline/history/index.html b/site/0_timeline/history/index.html index 6400aaa..1f5e427 100644 --- a/site/0_timeline/history/index.html +++ b/site/0_timeline/history/index.html @@ -356,7 +356,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -665,7 +762,7 @@ - + diff --git a/site/0_timeline/the-experiment/index.html b/site/0_timeline/the-experiment/index.html index d6a07a9..ad0e419 100644 --- a/site/0_timeline/the-experiment/index.html +++ b/site/0_timeline/the-experiment/index.html @@ -356,7 +356,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -595,7 +692,13 @@

    The Experiment

    - +

    Smartup Zero is an experiment to validate a radically transparent, democratic, public-good technology incubation modelβ€”"the Smartup Model"β€”with ONLIFE as its flagship project. The goal is to produce a resilient, open, mission-driven tech for the common good, addressing the limitations of traditional, venture-funded innovation pathways.

    + @@ -616,7 +719,7 @@ - 2025-07-07 + 2025-07-14 @@ -665,7 +768,7 @@ - + diff --git a/site/0_timeline/the-observation/index.html b/site/0_timeline/the-observation/index.html index c1dd71d..0f6d2ce 100644 --- a/site/0_timeline/the-observation/index.html +++ b/site/0_timeline/the-observation/index.html @@ -356,7 +356,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -665,7 +762,7 @@ - + diff --git a/site/0_timeline/the-smartup-hypothesis/index.html b/site/0_timeline/the-smartup-hypothesis/index.html index f699d4f..86f07b3 100644 --- a/site/0_timeline/the-smartup-hypothesis/index.html +++ b/site/0_timeline/the-smartup-hypothesis/index.html @@ -356,7 +356,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -665,7 +762,7 @@ - + diff --git a/site/404.html b/site/404.html index 7672488..593d550 100644 --- a/site/404.html +++ b/site/404.html @@ -333,7 +333,7 @@
  • - + @@ -538,6 +538,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -603,7 +700,7 @@ - + diff --git a/site/_snippets/join-cta/index.html b/site/_snippets/join-cta/index.html new file mode 100644 index 0000000..619b3a4 --- /dev/null +++ b/site/_snippets/join-cta/index.html @@ -0,0 +1,800 @@ + + + + + + + + + + + + + + + + + + + + + + + Join cta - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    Join cta

    + +

    Ready to Contribute?

    +
    +

    +

    Join the Project

    +

    Become a Smartup Zero owner

    +

    Join via Open Collective

    +

    +

    Start Discussing

    +

    Connect with the community

    +

    Enter Matrix Space

    +

    +

    Start Building

    +

    Pick up your first task

    +

    Browse Open Tasks

    +
    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_snippets/phase-indicator/index.html b/site/_snippets/phase-indicator/index.html new file mode 100644 index 0000000..f5bf157 --- /dev/null +++ b/site/_snippets/phase-indicator/index.html @@ -0,0 +1,770 @@ + + + + + + + + + + + + + + + + + + + + + + + Phase indicator - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    Phase indicator

    + +
    +

    Phase Status

    +

    Status: Active
    +Duration: 30 days
    +Started: January 1, 2025
    +Target End: January 31, 2025

    +
    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_snippets/readme/index.html b/site/_snippets/readme/index.html new file mode 100644 index 0000000..dc760c3 --- /dev/null +++ b/site/_snippets/readme/index.html @@ -0,0 +1,786 @@ + + + + + + + + + + + + + + + + + + + + + + + Readme - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    Readme

    + +

    status card: This snippet can be included in any page using:

    +
    +
      +
    • +

      Completed

      +
      +

      [Description of completed item]

      +

      View details

      +
    • +
    • +

      In Progress

      +
      +

      [Description of in-progress item]

      +

      Track progress

      +
    • +
    • +

      Planned

      +
      +

      [Description of planned item]

      +

      See roadmap

      +
    • +
    +
    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_snippets/status-card/index.html b/site/_snippets/status-card/index.html new file mode 100644 index 0000000..b9023c1 --- /dev/null +++ b/site/_snippets/status-card/index.html @@ -0,0 +1,785 @@ + + + + + + + + + + + + + + + + + + + + + + + Status card - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    Status card

    + +
    +
      +
    • +

      Completed

      +
      +

      [Description of completed item]

      +

      View details

      +
    • +
    • +

      In Progress

      +
      +

      [Description of in-progress item]

      +

      Track progress

      +
    • +
    • +

      Planned

      +
      +

      [Description of planned item]

      +

      See roadmap

      +
    • +
    +
    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_snippets/team-card/index.html b/site/_snippets/team-card/index.html new file mode 100644 index 0000000..2305ff3 --- /dev/null +++ b/site/_snippets/team-card/index.html @@ -0,0 +1,798 @@ + + + + + + + + + + + + + + + + + + + + + + + Team card - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    Team card

    + +

    Team Name

    +
    +

    Quick Links

    +

    Repos
    + Chat
    + Tasks

    +
    +

    Captain: @username
    +Members: 5 active
    +Mission: One-line mission statement

    +

    Current Focus: +- Current objective 1 +- Current objective 2

    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_templates/index.html b/site/_templates/index.html new file mode 100644 index 0000000..330cb32 --- /dev/null +++ b/site/_templates/index.html @@ -0,0 +1,824 @@ + + + + + + + + + + + + + + + + + + + + + + + πŸ“‹ Smartup Zero Content Templates - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    πŸ“‹ Smartup Zero Content Templates

    +

    This directory contains templates for common page types. Using these templates ensures consistency across all documentation.

    +

    Available Templates

    +

    πŸ“… phase-page.md

    +

    Use this template when documenting project phases.

    +

    Usage: +```bash +cp docs/_templates/phase-page.md docs/0_timeline/phases/phase-0-micropilot.md

    +

    Then edit to fill in the [placeholders]

    +

    When to use:

    +

    Documenting any of the 4 phases (Validation, Design, Production, Organization) +Creating phase-specific status pages +Planning future phases +How to Use Templates +Copy the template to your target location +Replace all [placeholder] text with actual content +Remove any sections that aren't relevant +Follow the style guide for formatting +Creating New Templates +When creating new templates:

    +

    Use clear placeholders in [Square Brackets] +Include all standard components from the style guide +Add usage instructions to this README +Test the template by creating a sample page

    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_templates/page-template/index.html b/site/_templates/page-template/index.html new file mode 100644 index 0000000..830b563 --- /dev/null +++ b/site/_templates/page-template/index.html @@ -0,0 +1,821 @@ + + + + + + + + + + + + + + + + + + + + + + + :material-icon: Page Title - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    :material-icon: Page Title

    +
    +

    What is this?

    +

    One-sentence explanation of what this page covers.

    +
    +

    Purpose

    +

    Brief paragraph explaining why this matters in the Smartup Zero context.

    +

    Main Content

    +

    Your content here...

    +

    Next Steps

    +

    What the reader should do after reading this page.

    +
    +

    Related Topics

    + +
    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_templates/phase-page/index.html b/site/_templates/phase-page/index.html new file mode 100644 index 0000000..71bb3a2 --- /dev/null +++ b/site/_templates/phase-page/index.html @@ -0,0 +1,933 @@ + + + + + + + + + + + + + + + + + + + + + + + :material-numeric-[X]-circle: Phase [Number]: [Phase Name] - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    :material-numeric-[X]-circle: Phase [Number]: [Phase Name]

    +
    +

    What is this?

    +

    This page documents Phase [Number] of the Smartup Zero experiment, including goals, timeline, and deliverables.

    +
    +

    Overview

    +
    +

    Phase Status

    +

    Status: [Not Started/Active/Complete]
    +Duration: [X] days
    +Started: [Date or TBD]
    +Target End: [Date or TBD]
    +Actual End: [Date or TBD]

    +
    +

    [Brief description of what this phase is about and why it's important]

    +

    Goals & Success Criteria

    +

    Primary Goals

    +
      +
    • [ ] Goal 1: [Specific, measurable goal]
    • +
    • Success metric: [How we measure completion]
    • +
    • +

      Current status: [Progress update]

      +
    • +
    • +

      [ ] Goal 2: [Specific, measurable goal]

      +
    • +
    • Success metric: [How we measure completion]
    • +
    • Current status: [Progress update]
    • +
    +

    Deliverables

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    DeliverableDescriptionOwnerStatus
    [Name][What it is]@team/person Done
    [Name][What it is]@team/person In Progress
    [Name][What it is]@team/person Planned
    +

    Timeline

    +

    ```mermaid +gantt + title Phase [Number] Timeline + dateFormat YYYY-MM-DD + section Preparation + [Task 1] :2025-01-01, 7d + section Development + [Task 2] :7d + [Task 3] :7d + section Review + [Task 4] :3d +Budget & Resources +Financial Requirements +Target Funding: €[Amount] +Raised: €[Amount] +Burn Rate: €[Amount]/month +Human Resources +Contributors Needed: [Number] +Current Team Size: [Number] +Key Roles to Fill: [List] +Key Decisions & Gates

    +
    +

    Phase Gate Requirements

    +
    +

    Before proceeding to the next phase, we must:

    +

    text +1. Achieve financial target of €[Amount] +2. Complete all primary deliverables +3. Pass scientific review (if applicable) +4. Hold binding vote to proceed +Lessons Learned

    +
    +Insights from this phase +
    +

    Document key learnings as the phase progresses:

    +

    text +- What worked well +- What didn't work +- What we'd do differently +- Recommendations for future phases

    +

    Related Documents +Previous Phase +Next Phase +Overall Experiment +Project Timeline

    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_templates/team-page/index.html b/site/_templates/team-page/index.html new file mode 100644 index 0000000..704da62 --- /dev/null +++ b/site/_templates/team-page/index.html @@ -0,0 +1,1038 @@ + + + + + + + + + + + + + + + + + + + + + + + [Team Name] Team - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    [Team Name] Team

    +
    +

    What is this?

    +

    This page describes the [Team Name] team's mission, members, and current work.

    +
    +

    Purpose

    +

    [Explain why this team exists and what unique value it brings to Smartup Zero]

    +

    Team Structure

    +
    +

    Quick Links

    +

    Team Repos
    + Team Room
    + Open Tasks

    +
    +

    Captain: @username
    +Members: X active contributors
    +Formed: [Month Year]

    +

    Team Members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    MemberRoleJoinedSpecialties
    @captainTeam CaptainJan 2025Leadership, [Skill]
    @member1[Role]Jan 2025[Skills]
    @member2[Role]Jan 2025[Skills]
    +

    Mission Statement

    +

    [One clear paragraph describing what this team is responsible for]

    +

    Current Objectives

    +

    Active Objectives

    +
      +
    1. [Objective Name] (Due: [Date])
    2. +
    3. Description of what needs to be achieved
    4. +
    5. Key deliverable
    6. +
    7. +

      Success metrics

      +
    8. +
    9. +

      [Objective Name] (Due: [Date])

      +
    10. +
    11. Description of what needs to be achieved
    12. +
    13. Key deliverable
    14. +
    15. Success metrics
    16. +
    +

    Completed Objectives

    +
    +View completed work +
      +
    • [Objective] - Completed [Date]
    • +
    • [Objective] - Completed [Date]
    • +
    +
    +

    How We Work

    +

    Communication

    +
      +
    • Primary Channel: Element room #3_[team-name]
    • +
    • Meetings: [Frequency] at [Time] UTC
    • +
    • Decisions: Made by consensus, escalated to captain if needed
    • +
    +

    Contribution Process

    +
      +
    1. Check open tasks in our project board
    2. +
    3. Comment on task to claim it
    4. +
    5. Submit PR when complete
    6. +
    7. Captain or designated reviewer approves
    8. +
    +

    Resources

    +

    Documentation

    + +

    Tools

    +
      +
    • [Tool 1] - Purpose
    • +
    • [Tool 2] - Purpose
    • +
    +

    Join Our Team

    +

    Interested in joining the [Team Name] team? Here's how:

    +
      +
    1. Join the General Forum
    2. +
    3. Introduce yourself in our team room
    4. +
    5. Pick up a "good first task"
    6. +
    7. Attend our next team meeting
    8. +
    +
    +

    Questions?

    +

    Reach out to our captain @captain in Element

    +
    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/_templates/team-template/index.html b/site/_templates/team-template/index.html new file mode 100644 index 0000000..aba1e4a --- /dev/null +++ b/site/_templates/team-template/index.html @@ -0,0 +1,799 @@ + + + + + + + + + + + + + + + + + + + + + + + Team template - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + +

    Team template

    + +

    Team Name

    +
    +

    Quick Links

    +

    Team Repos
    + Team Room
    + Open Tasks

    +
    +

    Captain: @username
    +Members: X active contributors
    +Formed: Month Year

    +

    Mission: One clear sentence describing the team's purpose.

    +

    Current Objectives: +- Objective 1 with deadline +- Objective 2 with deadline

    + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/index.html b/site/index.html index edd1061..2a5042a 100644 --- a/site/index.html +++ b/site/index.html @@ -427,7 +427,7 @@
  • - + @@ -632,6 +632,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -733,10 +830,10 @@
    -

    The Observation: A Global Promise, A Stalled Reality

    +

    The Observation: A Global Promise, A Stalled Reality

    In 2015, the world agreed on a plan: the 17 Sustainable Development Goals (SDGs). It was a historic commitment to end poverty, protect the planet, and build a just society by 2030.

    But we are not on track. The traditional models for innovation, optimized for profit over public good, are failing to deliver the tools we need.

    -

    The Hypothesis: A New Kind of Company

    +

    The Hypothesis: A New Kind of Company

    What if we could change mindsets by changing toolsets? This is the Smartup Hypothesis.

    It defines a new model for building technologyβ€”one based on radical transparency and collective power.

    @@ -749,10 +846,10 @@

    0_timeline is the marketplace where these Smartups are born. Scientists and experts define the problems our world faces (the demand). We, the people, provide the solutions (the supply).

    -

    The Experiment: Smartup Zero is Live

    +

    The Experiment: Smartup Zero is Live

    A hypothesis must be tested. Smartup Zero is that test. It is the first Smartup, Patient Zero, created to prove this model can work.

    Our mission is to build ONLIFE: a decentralized emergency communication network that works when all others fail. A tool for resilience, not for profit.

    -

    Your Role: You Are The Supply Side

    +

    Your Role: You Are The Supply Side

    This entire system is designed for you to take an active role. You are not a user; you are a co-creator. At 0_timeline, there are two ways to build a better future:

    @@ -843,7 +940,7 @@ - + diff --git a/site/search/search_index.json b/site/search/search_index.json index 8e37b2b..018f738 100644 --- a/site/search/search_index.json +++ b/site/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"The System Change Marketplace","text":"BING! YOU ARRIVED AT 0_TIMELINE Here we don\u2019t accept our reality but seek to alter it.

    The clock is ticking. The systems we rely on are not solving the world's most critical problems fast enough. We need a new engine for change.

    0_timeline is that engine. A place to build a better reality.

    "},{"location":"#the-observation-a-global-promise-a-stalled-reality","title":"The Observation: A Global Promise, A Stalled Reality","text":"

    In 2015, the world agreed on a plan: the 17 Sustainable Development Goals (SDGs). It was a historic commitment to end poverty, protect the planet, and build a just society by 2030.

    But we are not on track. The traditional models for innovation, optimized for profit over public good, are failing to deliver the tools we need.

    "},{"location":"#the-hypothesis-a-new-kind-of-company","title":"The Hypothesis: A New Kind of Company","text":"

    What if we could change mindsets by changing toolsets? This is the Smartup Hypothesis.

    It defines a new model for building technology\u2014one based on radical transparency and collective power.

    The Smartup Model

    A Smartup is a mission-driven company built on three pillars:

    0_timeline is the marketplace where these Smartups are born. Scientists and experts define the problems our world faces (the demand). We, the people, provide the solutions (the supply).

    "},{"location":"#the-experiment-smartup-zero-is-live","title":"The Experiment: Smartup Zero is Live","text":"

    A hypothesis must be tested. Smartup Zero is that test. It is the first Smartup, Patient Zero, created to prove this model can work.

    Our mission is to build ONLIFE: a decentralized emergency communication network that works when all others fail. A tool for resilience, not for profit.

    "},{"location":"#your-role-you-are-the-supply-side","title":"Your Role: You Are The Supply Side","text":"

    This entire system is designed for you to take an active role. You are not a user; you are a co-creator. At 0_timeline, there are two ways to build a better future:

    Create Partake Submit a solution. Have an idea for a new tool that can tackle one of the SDGs? Propose it and start a new Smartup. Join a mission. Lend your skills, knowledge, and time to an existing Smartup. Help build a solution you believe in.

    Smartup Zero is building now, and we need you. This is your invitation to help create the good side of history.

    Join the Smartup Zero Experiment Explore the Full Blueprint

    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"The System Change Marketplace","text":"BING! YOU ARRIVED AT 0_TIMELINE Here we don\u2019t accept our reality but seek to alter it.

    The clock is ticking. The systems we rely on are not solving the world's most critical problems fast enough. We need a new engine for change.

    0_timeline is that engine. A place to build a better reality.

    "},{"location":"#the-observation-a-global-promise-a-stalled-reality","title":"The Observation: A Global Promise, A Stalled Reality","text":"

    In 2015, the world agreed on a plan: the 17 Sustainable Development Goals (SDGs). It was a historic commitment to end poverty, protect the planet, and build a just society by 2030.

    But we are not on track. The traditional models for innovation, optimized for profit over public good, are failing to deliver the tools we need.

    "},{"location":"#the-hypothesis-a-new-kind-of-company","title":"The Hypothesis: A New Kind of Company","text":"

    What if we could change mindsets by changing toolsets? This is the Smartup Hypothesis.

    It defines a new model for building technology\u2014one based on radical transparency and collective power.

    The Smartup Model

    A Smartup is a mission-driven company built on three pillars:

    0_timeline is the marketplace where these Smartups are born. Scientists and experts define the problems our world faces (the demand). We, the people, provide the solutions (the supply).

    "},{"location":"#the-experiment-smartup-zero-is-live","title":"The Experiment: Smartup Zero is Live","text":"

    A hypothesis must be tested. Smartup Zero is that test. It is the first Smartup, Patient Zero, created to prove this model can work.

    Our mission is to build ONLIFE: a decentralized emergency communication network that works when all others fail. A tool for resilience, not for profit.

    "},{"location":"#your-role-you-are-the-supply-side","title":"Your Role: You Are The Supply Side","text":"

    This entire system is designed for you to take an active role. You are not a user; you are a co-creator. At 0_timeline, there are two ways to build a better future:

    Create Partake Submit a solution. Have an idea for a new tool that can tackle one of the SDGs? Propose it and start a new Smartup. Join a mission. Lend your skills, knowledge, and time to an existing Smartup. Help build a solution you believe in.

    Smartup Zero is building now, and we need you. This is your invitation to help create the good side of history.

    Join the Smartup Zero Experiment Explore the Full Blueprint

    "},{"location":"style-guide/","title":"\ud83d\udcd6 0_timeline Content Style Guide","text":"

    Purpose

    This guide ensures consistent content across the 0_timeline website. All contributors should reference this when creating or editing content. Our goal is to make complex ideas accessible while maintaining the experimental, transparent spirit of Smartup Zero.

    "},{"location":"style-guide/#visual-language","title":"\ud83c\udfa8 Visual Language","text":""},{"location":"style-guide/#icon-dictionary","title":"Icon Dictionary","text":"

    Always use these icons for consistency across all pages:

    Concept Icon Code Usage Preview Organizational Structure General Forum :material-forum: Public discussions, voting, governance Workplace :material-briefcase: Worker-only spaces and content Teams :material-account-group: Team-related content Roles :material-card-account-details: Role definitions and assignments Objectives :material-target: Project goals and missions Tasks :material-checkbox-marked-circle: Individual work items Project Specifics ONLIFE :material-alert-decagram: Emergency network references Smartup Model :material-atom: Core model concepts Experiment :material-flask: Scientific method references Actions & States Vote :material-vote: Governance decisions Join :material-account-plus: Recruitment/onboarding Build :material-hammer: Development work Success :material-check-circle: Completed/positive items Warning :material-alert: Important notices Info :material-information: Explanations Financial Treasury :material-currency-eur: Money/funding matters Credits :material-coin: Smartup Credits (SC) Technical Code :material-code-tags: Development/repos Infrastructure :material-server: Technical stack Communication :material-chat: Matrix/Element"},{"location":"style-guide/#color-philosophy","title":"Color Philosophy","text":""},{"location":"style-guide/#content-patterns","title":"\ud83d\udcd0 Content Patterns","text":""},{"location":"style-guide/#page-headers","title":"Page Headers","text":"

    Every page should start with a clear hierarchy.

    Example Code:

    ###:material-forum: Our General Forum\n\n!!! info \"What is this?\"\n    The public square for all Smartup Zero owners where governance happens.\n\n### Purpose\n\nThis is where we make collective decisions that shape our project's future.\n

    Renders as:

    "},{"location":"style-guide/#our-general-forum","title":"Our General Forum","text":"

    What is this?

    The public square for all Smartup Zero owners where governance happens.

    Purpose

    This is where we make collective decisions that shape our project's future.

    "},{"location":"style-guide/#status-indicators","title":"Status Indicators","text":"

    For showing project or phase status.

    Example Code:

    <div class=\"grid cards\" markdown>\n\n- :material-check-circle:{ .lg .middle } **Infrastructure**\n\n    ---\n\n    Core services deployed and operational\n\n    [:octicons-arrow-right-24: View details](#)\n\n- :material-progress-clock:{ .lg .middle } **ONLIFE Development**\n\n    ---\n\n    Building the MVP emergency network\n\n    [:octicons-arrow-right-24: Track progress](#)\n\n- :material-calendar-clock:{ .lg .middle } **First Funding**\n\n    ---\n\n    Crowdfunding campaign preparation\n\n    [:octicons-arrow-right-24: See timeline](#)\n\n</div>\n

    Renders as:

    "},{"location":"style-guide/#team-cards","title":"Team Cards","text":"

    Standard format for presenting teams.

    Example Code:

    **:material-account-group: Development Team**\n\n<aside class=\"md-typeset\" markdown>\n!!! tip inline end \"Quick Links\"\n    :material-git: [Team Repos](https://smartup-zero-forgejo.fly.dev/smartup-zero/dev-team)  \n    :material-chat: [Team Room](#3_dev-team)  \n    :material-clipboard-list: [Open Tasks](#)\n</aside>\n\n**Captain:** [@alice](https://matrix.to/#/@alice:matrix.org)  \n**Members:** 5 active contributors  \n**Formed:** January 2025  \n\n**Mission:** Build the ONLIFE emergency communication protocol and apps.\n\n**Current Objectives:**\n- Complete Android MVP by Feb 28\n- Implement mesh networking core\n

    Renders as:

    Development Team

    Quick Links

    Team Repos Team Room Open Tasks

    Captain: @alice Members: 5 active contributors Formed: January 2025

    Mission: Build the ONLIFE emergency communication protocol and apps.

    Current Objectives: - Complete Android MVP by Feb 28 - Implement mesh networking core

    "},{"location":"style-guide/#phase-documentation","title":"Phase Documentation","text":"

    For describing project phases.

    Example Code:

    **:material-numeric-0-circle: Phase 0: Micro-Pilot**\n\n<aside class=\"md-typeset\" markdown>\n!!! info inline end \"Phase Status\"\n    **Status:** Active  \n    **Duration:** 30 days  \n    **Started:** Jan 1, 2025  \n    **Target:** Jan 31, 2025\n</aside>\n\n**Goals for This Phase**\n\n- [x] Deploy core infrastructure\n- [ ] Onboard 15-20 contributors\n- [ ] Complete one full work cycle\n\n**Key Deliverables**\n\n| Deliverable | Description | Status |\n|-------------|-------------|---------|\n| Tech Stack | Forgejo + Matrix deployed | :material-check: Done |\n| Engelbot | Automation bot v0.1 | :material-progress-wrench: In Progress |\n| First Task | Test the SC system | :material-calendar: Planned |\n

    Renders as:

    Phase 0: Micro-Pilot

    Phase Status

    Status: Active Duration: 30 days Started: Jan 1, 2025 Target: Jan 31, 2025

    Goals for This Phase

    Key Deliverables

    Deliverable Description Status Tech Stack Forgejo + Matrix deployed Done Engelbot Automation bot v0.1 In Progress First Task Test the SC system Planned"},{"location":"style-guide/#call-to-action-sections","title":"Call-to-Action Sections","text":"

    For encouraging participation.

    Example Code:

    **:material-rocket-launch: Ready to Contribute?**\n\n<div class=\"grid\" markdown>\n\n:material-account-plus:{ .lg }\n\n**Join the Project**\n\nBecome a Smartup Zero owner\n\n[Join via Open Collective :material-open-in-new:](https://opencollective.com/smartup-zero){ .md-button }\n\n:material-chat:{ .lg }\n\n**Start Discussing**\n\nConnect with the community\n\n[Enter Matrix Space :material-open-in-new:](#){ .md-button }\n\n:material-hammer:{ .lg }\n\n**Start Building**\n\nPick up your first task\n\n[Browse Open Tasks :material-open-in-new:](#){ .md-button }\n\n</div>\n

    Renders as:

    Ready to Contribute?

    Join the Project

    Become a Smartup Zero owner

    Join via Open Collective

    Start Discussing

    Connect with the community

    Enter Matrix Space

    Start Building

    Pick up your first task

    Browse Open Tasks

    "},{"location":"style-guide/#writing-guidelines","title":"\ud83d\udcdd Writing Guidelines","text":""},{"location":"style-guide/#voice-tone","title":"Voice & Tone","text":""},{"location":"style-guide/#structure-guidelines","title":"Structure Guidelines","text":"
    1. Start with Why: Lead with purpose/problem before solution
    2. Show, Don't Just Tell: Use examples and diagrams
    3. Progressive Disclosure: Overview first, details in expandable sections

    Example Code:

    ** The Smartup Credit System\n\n**Why it exists:** We need a fair way to track and reward contributions before cash arrives.\n\n??? info \"How it works (Technical Details)\"\n    When a contributor completes a task, the Team Captain approves it and \n    Smartup Credits are minted to the ledger. These credits represent a \n    future claim on treasury funds at a 1 SC = 1 EUR rate.\n

    Renders as:

    The Smartup Credit System

    Why it exists: We need a fair way to track and reward contributions before cash arrives.

    How it works (Technical Details)

    When a contributor completes a task, the Team Captain approves it and Smartup Credits are minted to the ledger. These credits represent a future claim on treasury funds at a 1 SC = 1 EUR rate.

    "},{"location":"style-guide/#common-phrases","title":"Common Phrases","text":"

    Use these standardized phrases:

    "},{"location":"style-guide/#component-library","title":"\ud83e\udde9 Component Library","text":""},{"location":"style-guide/#definition-boxes","title":"Definition Boxes","text":"

    Example Code:

    !!! info \"Smartup\"\n    A new organizational model based on collective ownership, collective \n    craftsmanship, and collective governance.\n

    Renders as:

    Smartup

    A new organizational model based on collective ownership, collective craftsmanship, and collective governance.

    "},{"location":"style-guide/#warning-boxes","title":"Warning Boxes","text":"

    Example Code:

    !!! warning \"Experimental Phase\"\n    This process is still being tested in our micro-pilot. \n    Procedures may change based on learnings.\n

    Renders as:

    Experimental Phase

    This process is still being tested in our micro-pilot. Procedures may change based on learnings.

    "},{"location":"style-guide/#example-boxes","title":"Example Boxes","text":"

    Example Code:

    !!! example \"How This Works in Practice\"\n    When a developer completes a task worth 500 SC, the Team Captain \n    approves it, triggering an automatic ledger update via Engelbot.\n

    Renders as:

    How This Works in Practice

    When a developer completes a task worth 500 SC, the Team Captain approves it, triggering an automatic ledger update via Engelbot.

    "},{"location":"style-guide/#quote-boxes","title":"Quote Boxes","text":"

    Example Code:

    !!! quote \"Our Inscription\"\n    We don't accept our reality but seek to alter it. We are not too late \n    or too early but precisely on time. The next big thing will be a mosaic \n    of small things.\n

    Renders as:

    Our Inscription

    We don't accept our reality but seek to alter it. We are not too late or too early but precisely on time. The next big thing will be a mosaic of small things.

    "},{"location":"style-guide/#tabs-for-multiple-perspectives","title":"Tabs for Multiple Perspectives","text":"

    Example Code:

    === \":material-account: For Contributors\"\n\n    Learn how to join the project and start earning Smartup Credits \n    by contributing your skills to building ONLIFE.\n\n=== \":material-currency-eur: For Supporters\"\n\n    Discover how your financial support directly enables the development \n    of public-good technology with transparent fund allocation.\n\n=== \":material-cellphone: For Future Users\"\n\n    Understand how ONLIFE will provide emergency communication when \n    traditional networks fail.\n

    Renders as:

    For Contributors For Supporters For Future Users

    Learn how to join the project and start earning Smartup Credits by contributing your skills to building ONLIFE.

    Discover how your financial support directly enables the development of public-good technology with transparent fund allocation.

    Understand how ONLIFE will provide emergency communication when traditional networks fail.

    "},{"location":"style-guide/#expandable-details","title":"Expandable Details","text":"

    Example Code:

    ??? question \"What are Smartup Credits?\"\n\n    Smartup Credits (SC) are internal units that track contributions \n    before cash is available. 1 SC = 1 EUR claim on the treasury.\n\n??? tip \"Pro Tip: Claiming Your First Task\"\n\n    Start with tasks labeled \"good-first-task\" in Forgejo. Comment \n    on the issue to claim it before starting work.\n

    Renders as:

    What are Smartup Credits?

    Smartup Credits (SC) are internal units that track contributions before cash is available. 1 SC = 1 EUR claim on the treasury.

    Pro Tip: Claiming Your First Task

    Start with tasks labeled \"good-first-task\" in Forgejo. Comment on the issue to claim it before starting work.

    "},{"location":"style-guide/#button-styles","title":"Button Styles","text":"

    Example Code:

    [Primary Action :material-arrow-right:](#){ .md-button .md-button--primary }\n[Secondary Action](#){ .md-button }\n[Text Link with Icon :material-open-in-new:](#)\n

    Renders as:

    Primary Action Secondary Action Text Link with Icon

    "},{"location":"style-guide/#mermaid-diagrams","title":"Mermaid Diagrams","text":"

    Example Code:

    ```mermaid\ngraph TD\n    A[Contributor] -->|Creates| B[Task]\n    B -->|Completes| C[Review]\n    C -->|Approves| D[SC Minted]\n    D -->|Logged in| E[Ledger]\n```\n

    Renders as:

    graph TD\n    A[Contributor] -->|Creates| B[Task]\n    B -->|Completes| C[Review]\n    C -->|Approves| D[SC Minted]\n    D -->|Logged in| E[Ledger]\n
    "},{"location":"style-guide/#progress-indicators","title":"Progress Indicators","text":"

    Example Code:

    !!! abstract \"Micro-Pilot Progress\"\n    :material-progress-check: **35% Complete**\n\n    - [x] Infrastructure deployed\n    - [x] Core team assembled\n    - [ ] First work cycle\n    - [ ] Binding vote held\n

    Renders as:

    Micro-Pilot Progress

    35% Complete

    "},{"location":"style-guide/#technical-formatting","title":"\ud83d\udd27 Technical Formatting","text":""},{"location":"style-guide/#code-blocks","title":"Code Blocks","text":"

    Always specify language for syntax highlighting.

    Example Code:

    ```python\ndef mint_credits(worker, amount):\n    \"\"\"Mint Smartup Credits for completed work.\"\"\"\n    return ledger.add_entry(worker, amount)\n```\n

    Renders as:

    def mint_credits(worker, amount):\n    \"\"\"Mint Smartup Credits for completed work.\"\"\"\n    return ledger.add_entry(worker, amount)\n
    "},{"location":"style-guide/#file-contents","title":"File Contents","text":"

    Example Code:

    !!! example \"ledger.log\"\n    ```json\n    {\"type\": \"mint\", \"worker\": \"@alice\", \"amount\": 500, \"task\": \"#42\"}\n    ```\n

    Renders as:

    ledger.log

    {\"type\": \"mint\", \"worker\": \"@alice\", \"amount\": 500, \"task\": \"#42\"}\n
    "},{"location":"style-guide/#terminal-commands","title":"Terminal Commands","text":"

    Example Code:

    ```console\n$ git clone https://smartup-zero-forgejo.fly.dev/smartup-zero/0_timeline.git\n$ cd 0_timeline\n$ mkdocs serve\nINFO - Building documentation...\nINFO - Documentation built in 2.43 seconds\n```\n

    Renders as:

    $ git clone https://smartup-zero-forgejo.fly.dev/smartup-zero/0_timeline.git\n$ cd 0_timeline\n$ mkdocs serve\nINFO - Building documentation...\nINFO - Documentation built in 2.43 seconds\n
    "},{"location":"style-guide/#tables-and-data","title":"\ud83d\udcca Tables and Data","text":""},{"location":"style-guide/#standard-table-format","title":"Standard Table Format","text":"

    Example Code:

    | Component | Status | Notes |\n|-----------|--------|-------|\n| Matrix Server | :material-check-circle: Operational | 99.9% uptime |\n| Forgejo | :material-check-circle: Operational | v1.21.3 |\n| Engelbot | :material-progress-wrench: In Progress | v0.1 pending |\n

    Renders as:

    Component Status Notes Matrix Server Operational 99.9% uptime Forgejo Operational v1.21.3 Engelbot In Progress v0.1 pending"},{"location":"style-guide/#linking-strategy","title":"\ud83c\udf10 Linking Strategy","text":""},{"location":"style-guide/#internal-links","title":"Internal Links","text":""},{"location":"style-guide/#external-links","title":"External Links","text":""},{"location":"style-guide/#cross-references","title":"Cross-References","text":"

    Example Code:

    !!! tip \"Related Topics\"\n    - [The Smartup Model](../0_timeline/the-smartup-hypothesis.md)\n    - [How to Contribute](../smartup-zero/2_workplace.md)\n    - [Team Structure](../smartup-zero/3_teams.md)\n

    Renders as:

    Related Topics

    "},{"location":"style-guide/#checklist-for-new-pages","title":"\u2705 Checklist for New Pages","text":"

    Before publishing any new page, ensure:

    "},{"location":"style-guide/#quick-start-template","title":"\ud83d\ude80 Quick Start Template","text":"

    Copy this template when creating new pages:

    **:material-icon: Page Title\n\n!!! info \"What is this?\"\n    One-sentence explanation of what this page covers.\n\n**Purpose**\n\nBrief paragraph explaining why this matters in the Smartup Zero context.\n\n**Main Content**\n\nYour content here, following the patterns above...\n\n**:material-rocket-launch: Next Steps**\n\nWhat the reader should do after reading this page.\n\n!!! tip \"Related Topics\"\n    - [Related Page 1](link)\n    - [Related Page 2](link)\n

    Ready to Create Content!

    Now you have all the patterns and examples needed to create consistent, beautiful content for 0_timeline. Remember to reference this guide whenever you're unsure about formatting or style choices.

    "},{"location":"0_timeline/the-experiment/","title":"The Experiment","text":"

    Smartup Zero is an experiment to validate a radically transparent, democratic, public-good technology incubation model\u2014\"the Smartup Model\"\u2014with ONLIFE as its flagship project. The goal is to produce a resilient, open, mission-driven tech for the common good, addressing the limitations of traditional, venture-funded innovation pathways.

    "},{"location":"_snippets/join-cta/","title":"Join cta","text":""},{"location":"_snippets/join-cta/#ready-to-contribute","title":"Ready to Contribute?","text":"

    Join the Project

    Become a Smartup Zero owner

    Join via Open Collective

    Start Discussing

    Connect with the community

    Enter Matrix Space

    Start Building

    Pick up your first task

    Browse Open Tasks

    "},{"location":"_snippets/phase-indicator/","title":"Phase indicator","text":"

    Phase Status

    Status: Active Duration: 30 days Started: January 1, 2025 Target End: January 31, 2025

    "},{"location":"_snippets/readme/","title":"Readme","text":"

    status card: This snippet can be included in any page using:

    "},{"location":"_snippets/status-card/","title":"Status card","text":""},{"location":"_snippets/team-card/","title":"Team card","text":""},{"location":"_snippets/team-card/#team-name","title":"Team Name","text":"

    Quick Links

    Repos Chat Tasks

    Captain: @username Members: 5 active Mission: One-line mission statement

    Current Focus: - Current objective 1 - Current objective 2

    "},{"location":"_templates/","title":"\ud83d\udccb Smartup Zero Content Templates","text":"

    This directory contains templates for common page types. Using these templates ensures consistency across all documentation.

    "},{"location":"_templates/#available-templates","title":"Available Templates","text":""},{"location":"_templates/#phase-pagemd","title":"\ud83d\udcc5 phase-page.md","text":"

    Use this template when documenting project phases.

    Usage: ```bash cp docs/_templates/phase-page.md docs/0_timeline/phases/phase-0-micropilot.md

    "},{"location":"_templates/#then-edit-to-fill-in-the-placeholders","title":"Then edit to fill in the [placeholders]","text":"

    When to use:

    Documenting any of the 4 phases (Validation, Design, Production, Organization) Creating phase-specific status pages Planning future phases How to Use Templates Copy the template to your target location Replace all [placeholder] text with actual content Remove any sections that aren't relevant Follow the style guide for formatting Creating New Templates When creating new templates:

    Use clear placeholders in [Square Brackets] Include all standard components from the style guide Add usage instructions to this README Test the template by creating a sample page

    "},{"location":"_templates/page-template/","title":":material-icon: Page Title","text":"

    What is this?

    One-sentence explanation of what this page covers.

    "},{"location":"_templates/page-template/#purpose","title":"Purpose","text":"

    Brief paragraph explaining why this matters in the Smartup Zero context.

    "},{"location":"_templates/page-template/#main-content","title":"Main Content","text":"

    Your content here...

    "},{"location":"_templates/page-template/#next-steps","title":"Next Steps","text":"

    What the reader should do after reading this page.

    Related Topics

    "},{"location":"_templates/phase-page/","title":":material-numeric-[X]-circle: Phase [Number]: [Phase Name]","text":"

    What is this?

    This page documents Phase [Number] of the Smartup Zero experiment, including goals, timeline, and deliverables.

    "},{"location":"_templates/phase-page/#overview","title":"Overview","text":"

    Phase Status

    Status: [Not Started/Active/Complete] Duration: [X] days Started: [Date or TBD] Target End: [Date or TBD] Actual End: [Date or TBD]

    [Brief description of what this phase is about and why it's important]

    "},{"location":"_templates/phase-page/#goals-success-criteria","title":"Goals & Success Criteria","text":""},{"location":"_templates/phase-page/#primary-goals","title":"Primary Goals","text":""},{"location":"_templates/phase-page/#deliverables","title":"Deliverables","text":"Deliverable Description Owner Status [Name] [What it is] @team/person Done [Name] [What it is] @team/person In Progress [Name] [What it is] @team/person Planned"},{"location":"_templates/phase-page/#timeline","title":"Timeline","text":"

    ```mermaid gantt title Phase [Number] Timeline dateFormat YYYY-MM-DD section Preparation [Task 1] :2025-01-01, 7d section Development [Task 2] :7d [Task 3] :7d section Review [Task 4] :3d Budget & Resources Financial Requirements Target Funding: \u20ac[Amount] Raised: \u20ac[Amount] Burn Rate: \u20ac[Amount]/month Human Resources Contributors Needed: [Number] Current Team Size: [Number] Key Roles to Fill: [List] Key Decisions & Gates

    Phase Gate Requirements

    Before proceeding to the next phase, we must:

    text 1. Achieve financial target of \u20ac[Amount] 2. Complete all primary deliverables 3. Pass scientific review (if applicable) 4. Hold binding vote to proceed Lessons Learned

    Insights from this phase

    Document key learnings as the phase progresses:

    text - What worked well - What didn't work - What we'd do differently - Recommendations for future phases

    Related Documents Previous Phase Next Phase Overall Experiment Project Timeline

    "},{"location":"_templates/team-page/","title":"[Team Name] Team","text":"

    What is this?

    This page describes the [Team Name] team's mission, members, and current work.

    "},{"location":"_templates/team-page/#purpose","title":"Purpose","text":"

    [Explain why this team exists and what unique value it brings to Smartup Zero]

    "},{"location":"_templates/team-page/#team-structure","title":"Team Structure","text":"

    Quick Links

    Team Repos Team Room Open Tasks

    Captain: @username Members: X active contributors Formed: [Month Year]

    "},{"location":"_templates/team-page/#team-members","title":"Team Members","text":"Member Role Joined Specialties @captain Team Captain Jan 2025 Leadership, [Skill] @member1 [Role] Jan 2025 [Skills] @member2 [Role] Jan 2025 [Skills]"},{"location":"_templates/team-page/#mission-statement","title":"Mission Statement","text":"

    [One clear paragraph describing what this team is responsible for]

    "},{"location":"_templates/team-page/#current-objectives","title":"Current Objectives","text":""},{"location":"_templates/team-page/#active-objectives","title":"Active Objectives","text":"
    1. [Objective Name] (Due: [Date])
    2. Description of what needs to be achieved
    3. Key deliverable
    4. Success metrics

    5. [Objective Name] (Due: [Date])

    6. Description of what needs to be achieved
    7. Key deliverable
    8. Success metrics
    "},{"location":"_templates/team-page/#completed-objectives","title":"Completed Objectives","text":"View completed work "},{"location":"_templates/team-page/#how-we-work","title":"How We Work","text":""},{"location":"_templates/team-page/#communication","title":"Communication","text":""},{"location":"_templates/team-page/#contribution-process","title":"Contribution Process","text":"
    1. Check open tasks in our project board
    2. Comment on task to claim it
    3. Submit PR when complete
    4. Captain or designated reviewer approves
    "},{"location":"_templates/team-page/#resources","title":"Resources","text":""},{"location":"_templates/team-page/#documentation","title":"Documentation","text":""},{"location":"_templates/team-page/#tools","title":"Tools","text":""},{"location":"_templates/team-page/#join-our-team","title":"Join Our Team","text":"

    Interested in joining the [Team Name] team? Here's how:

    1. Join the General Forum
    2. Introduce yourself in our team room
    3. Pick up a \"good first task\"
    4. Attend our next team meeting

    Questions?

    Reach out to our captain @captain in Element

    "},{"location":"_templates/team-template/","title":"Team template","text":""},{"location":"_templates/team-template/#team-name","title":"Team Name","text":"

    Quick Links

    Team Repos Team Room Open Tasks

    Captain: @username Members: X active contributors Formed: Month Year

    Mission: One clear sentence describing the team's purpose.

    Current Objectives: - Objective 1 with deadline - Objective 2 with deadline

    "}]} \ No newline at end of file diff --git a/site/sitemap.xml b/site/sitemap.xml index 7db1e2d..21724d4 100644 --- a/site/sitemap.xml +++ b/site/sitemap.xml @@ -2,46 +2,90 @@ https://0_timeline.org/ - 2025-07-14 + 2025-07-15 + + + https://0_timeline.org/style-guide/ + 2025-07-15 https://0_timeline.org/0_timeline/history/ - 2025-07-14 + 2025-07-15 https://0_timeline.org/0_timeline/the-experiment/ - 2025-07-14 + 2025-07-15 https://0_timeline.org/0_timeline/the-observation/ - 2025-07-14 + 2025-07-15 https://0_timeline.org/0_timeline/the-smartup-hypothesis/ - 2025-07-14 + 2025-07-15 + + + https://0_timeline.org/_snippets/join-cta/ + 2025-07-15 + + + https://0_timeline.org/_snippets/phase-indicator/ + 2025-07-15 + + + https://0_timeline.org/_snippets/readme/ + 2025-07-15 + + + https://0_timeline.org/_snippets/status-card/ + 2025-07-15 + + + https://0_timeline.org/_snippets/team-card/ + 2025-07-15 + + + https://0_timeline.org/_templates/ + 2025-07-15 + + + https://0_timeline.org/_templates/page-template/ + 2025-07-15 + + + https://0_timeline.org/_templates/phase-page/ + 2025-07-15 + + + https://0_timeline.org/_templates/team-page/ + 2025-07-15 + + + https://0_timeline.org/_templates/team-template/ + 2025-07-15 https://0_timeline.org/smartup-zero/1_general_forum/ - 2025-07-14 + 2025-07-15 https://0_timeline.org/smartup-zero/2_workplace/ - 2025-07-14 + 2025-07-15 https://0_timeline.org/smartup-zero/3_teams/ - 2025-07-14 + 2025-07-15 https://0_timeline.org/smartup-zero/4_roles/ - 2025-07-14 + 2025-07-15 https://0_timeline.org/smartup-zero/5_objectives/ - 2025-07-14 + 2025-07-15 https://0_timeline.org/smartup-zero/6_tasks/ - 2025-07-14 + 2025-07-15 \ No newline at end of file diff --git a/site/sitemap.xml.gz b/site/sitemap.xml.gz index d3784229d241abb655b758e123a3091e46864742..4288338c341140d28faf7d0b62b94520267aed30 100644 GIT binary patch literal 382 zcmV-^0fGJ>iwFn+nssOb|8r?{Wo=<_E_iKh0L7NiZi6rk#_xR!#65&|>;8$-+n!)M zM``dNEhJHFO1r0DpzXHnG>POwY^?A1$+4mo+f&yjNARev*`&)XPZKc8R@&5?^!@FX zJ*C@nQS`n=pd=I<+@uYWd*OT-h72`9Cmm+i*Bn(70_4{u&$H*WTqI$Q0+-#iiq@)f zRKXyV3(_65+Q1}I@bTyGT8Y%zs$Au(HOn8_ave&pxr;deR{sMB>D&UVdtJe7%%6}q z8p--|3^X;s;N-xEgrQgt><+;nC56F@WdS?ssdub7I~!uuIGYoJMmq5$FW6o0%PMWYt~v=M_o z9d}gt?7hETt)Jj6Uy2$Gc-e{%>-#Q_iIo_vKZGu*NL{!S<56H7_`UG9g-GzVu)94d c(#Kd19t24|`~yCH!V|ds0vD8##WD*30IAlv$N&HU literal 297 zcmV+^0oMK>iwFpSNOWid|8r?{Wo=<_E_iKh0L4_xZo?oDyyq({-)(F+=}V4t>ld_V zM4YWn11w@Uani3ZdGv9uDwVy!45OKmK(woaHQ62lX>`lHE~`8P*W*UJVVS=?KNa`+ zs++aDU7b=V=Z0-N}Wb zO(j`dFxtV{q!p*bpISw1anm(bvnZ;&qMk>|mAjaWFZW;Md_ys6VhqO=(L6!{2M-|< zj#D+jH9^=bj*lQ!1+pse&KKj+W5lHC-!s; v1#TpRvWc!>E(01!6uywSeuJL%K2?KT$%?jr2tP0JyY4;!GXgCO-UR>vHvESt diff --git a/site/smartup-zero/1_general_forum/index.html b/site/smartup-zero/1_general_forum/index.html index 7b12ead..5ca0947 100644 --- a/site/smartup-zero/1_general_forum/index.html +++ b/site/smartup-zero/1_general_forum/index.html @@ -348,7 +348,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -665,7 +762,7 @@ - + diff --git a/site/smartup-zero/2_workplace/index.html b/site/smartup-zero/2_workplace/index.html index f456301..46dc898 100644 --- a/site/smartup-zero/2_workplace/index.html +++ b/site/smartup-zero/2_workplace/index.html @@ -348,7 +348,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -665,7 +762,7 @@ - + diff --git a/site/smartup-zero/3_teams/index.html b/site/smartup-zero/3_teams/index.html index 06b788f..992cd29 100644 --- a/site/smartup-zero/3_teams/index.html +++ b/site/smartup-zero/3_teams/index.html @@ -348,7 +348,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -665,7 +762,7 @@ - + diff --git a/site/smartup-zero/4_roles/index.html b/site/smartup-zero/4_roles/index.html index 919fbb2..b65e4cf 100644 --- a/site/smartup-zero/4_roles/index.html +++ b/site/smartup-zero/4_roles/index.html @@ -348,7 +348,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -665,7 +762,7 @@ - + diff --git a/site/smartup-zero/5_objectives/index.html b/site/smartup-zero/5_objectives/index.html index ac73109..eb29dea 100644 --- a/site/smartup-zero/5_objectives/index.html +++ b/site/smartup-zero/5_objectives/index.html @@ -348,7 +348,7 @@
  • - + @@ -561,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -665,7 +762,7 @@ - + diff --git a/site/smartup-zero/6_tasks/index.html b/site/smartup-zero/6_tasks/index.html index 2af460d..08d2500 100644 --- a/site/smartup-zero/6_tasks/index.html +++ b/site/smartup-zero/6_tasks/index.html @@ -16,6 +16,8 @@ + + @@ -346,7 +348,7 @@
  • - + @@ -559,6 +561,103 @@ + + + + + + +
  • + + + + + + --- + + + + + +
  • + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + + + +
  • + + + @@ -663,7 +762,7 @@ - + diff --git a/site/style-guide/index.html b/site/style-guide/index.html new file mode 100644 index 0000000..fdb0ea5 --- /dev/null +++ b/site/style-guide/index.html @@ -0,0 +1,2321 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Style Guide - 0_timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    + +
    + + + +
    +
    + + + + + +

    πŸ“– 0_timeline Content Style Guide

    +
    +

    Purpose

    +

    This guide ensures consistent content across the 0_timeline website. All contributors should reference this when creating or editing content. Our goal is to make complex ideas accessible while maintaining the experimental, transparent spirit of Smartup Zero.

    +
    +

    🎨 Visual Language

    +

    Icon Dictionary

    +

    Always use these icons for consistency across all pages:

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ConceptIcon CodeUsagePreview
    Organizational Structure
    General Forum:material-forum:Public discussions, voting, governance
    Workplace:material-briefcase:Worker-only spaces and content
    Teams:material-account-group:Team-related content
    Roles:material-card-account-details:Role definitions and assignments
    Objectives:material-target:Project goals and missions
    Tasks:material-checkbox-marked-circle:Individual work items
    Project Specifics
    ONLIFE:material-alert-decagram:Emergency network references
    Smartup Model:material-atom:Core model concepts
    Experiment:material-flask:Scientific method references
    Actions & States
    Vote:material-vote:Governance decisions
    Join:material-account-plus:Recruitment/onboarding
    Build:material-hammer:Development work
    Success:material-check-circle:Completed/positive items
    Warning:material-alert:Important notices
    Info:material-information:Explanations
    Financial
    Treasury:material-currency-eur:Money/funding matters
    Credits:material-coin:Smartup Credits (SC)
    Technical
    Code:material-code-tags:Development/repos
    Infrastructure:material-server:Technical stack
    Communication:material-chat:Matrix/Element
    +

    Color Philosophy

    + +

    πŸ“ Content Patterns

    +

    Page Headers

    +

    Every page should start with a clear hierarchy.

    +

    Example Code: +

    ###:material-forum: Our General Forum
    +
    +!!! info "What is this?"
    +    The public square for all Smartup Zero owners where governance happens.
    +
    +### Purpose
    +
    +This is where we make collective decisions that shape our project's future.
    +

    +

    Renders as:

    +

    Our General Forum

    +
    +

    What is this?

    +

    The public square for all Smartup Zero owners where governance happens.

    +
    +

    Purpose

    +

    This is where we make collective decisions that shape our project's future.

    +

    Status Indicators

    +

    For showing project or phase status.

    +

    Example Code: +

    <div class="grid cards" markdown>
    +
    +- :material-check-circle:{ .lg .middle } **Infrastructure**
    +
    +    ---
    +
    +    Core services deployed and operational
    +
    +    [:octicons-arrow-right-24: View details](#)
    +
    +- :material-progress-clock:{ .lg .middle } **ONLIFE Development**
    +
    +    ---
    +
    +    Building the MVP emergency network
    +
    +    [:octicons-arrow-right-24: Track progress](#)
    +
    +- :material-calendar-clock:{ .lg .middle } **First Funding**
    +
    +    ---
    +
    +    Crowdfunding campaign preparation
    +
    +    [:octicons-arrow-right-24: See timeline](#)
    +
    +</div>
    +

    +

    Renders as:

    +
    + +
    +
    +

    Team Cards

    +

    Standard format for presenting teams.

    +

    Example Code: +

    **:material-account-group: Development Team**
    +
    +<aside class="md-typeset" markdown>
    +!!! tip inline end "Quick Links"
    +    :material-git: [Team Repos](https://smartup-zero-forgejo.fly.dev/smartup-zero/dev-team)  
    +    :material-chat: [Team Room](#3_dev-team)  
    +    :material-clipboard-list: [Open Tasks](#)
    +</aside>
    +
    +**Captain:** [@alice](https://matrix.to/#/@alice:matrix.org)  
    +**Members:** 5 active contributors  
    +**Formed:** January 2025  
    +
    +**Mission:** Build the ONLIFE emergency communication protocol and apps.
    +
    +**Current Objectives:**
    +- Complete Android MVP by Feb 28
    +- Implement mesh networking core
    +

    +

    Renders as:

    +

    Development Team

    + +

    Captain: @alice
    +Members: 5 active contributors
    +Formed: January 2025

    +

    Mission: Build the ONLIFE emergency communication protocol and apps.

    +

    Current Objectives: +- Complete Android MVP by Feb 28 +- Implement mesh networking core

    +
    +

    Phase Documentation

    +

    For describing project phases.

    +

    Example Code: +

    **:material-numeric-0-circle: Phase 0: Micro-Pilot**
    +
    +<aside class="md-typeset" markdown>
    +!!! info inline end "Phase Status"
    +    **Status:** Active  
    +    **Duration:** 30 days  
    +    **Started:** Jan 1, 2025  
    +    **Target:** Jan 31, 2025
    +</aside>
    +
    +**Goals for This Phase**
    +
    +- [x] Deploy core infrastructure
    +- [ ] Onboard 15-20 contributors
    +- [ ] Complete one full work cycle
    +
    +**Key Deliverables**
    +
    +| Deliverable | Description | Status |
    +|-------------|-------------|---------|
    +| Tech Stack | Forgejo + Matrix deployed | :material-check: Done |
    +| Engelbot | Automation bot v0.1 | :material-progress-wrench: In Progress |
    +| First Task | Test the SC system | :material-calendar: Planned |
    +

    +

    Renders as:

    +

    Phase 0: Micro-Pilot

    +
    +

    Phase Status

    +

    Status: Active
    +Duration: 30 days
    +Started: Jan 1, 2025
    +Target: Jan 31, 2025

    +
    +

    Goals for This Phase

    + +

    Key Deliverables

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    DeliverableDescriptionStatus
    Tech StackForgejo + Matrix deployed Done
    EngelbotAutomation bot v0.1 In Progress
    First TaskTest the SC system Planned
    +
    +

    Call-to-Action Sections

    +

    For encouraging participation.

    +

    Example Code: +

    **:material-rocket-launch: Ready to Contribute?**
    +
    +<div class="grid" markdown>
    +
    +:material-account-plus:{ .lg }
    +
    +**Join the Project**
    +
    +Become a Smartup Zero owner
    +
    +[Join via Open Collective :material-open-in-new:](https://opencollective.com/smartup-zero){ .md-button }
    +
    +:material-chat:{ .lg }
    +
    +**Start Discussing**
    +
    +Connect with the community
    +
    +[Enter Matrix Space :material-open-in-new:](#){ .md-button }
    +
    +:material-hammer:{ .lg }
    +
    +**Start Building**
    +
    +Pick up your first task
    +
    +[Browse Open Tasks :material-open-in-new:](#){ .md-button }
    +
    +</div>
    +

    +

    Renders as:

    +

    Ready to Contribute?

    +
    +

    +

    Join the Project

    +

    Become a Smartup Zero owner

    +

    Join via Open Collective

    +

    +

    Start Discussing

    +

    Connect with the community

    +

    Enter Matrix Space

    +

    +

    Start Building

    +

    Pick up your first task

    +

    Browse Open Tasks

    +
    +

    πŸ“ Writing Guidelines

    +

    Voice & Tone

    + +

    Structure Guidelines

    +
      +
    1. Start with Why: Lead with purpose/problem before solution
    2. +
    3. Show, Don't Just Tell: Use examples and diagrams
    4. +
    5. Progressive Disclosure: Overview first, details in expandable sections
    6. +
    +

    Example Code: +

    ** The Smartup Credit System
    +
    +**Why it exists:** We need a fair way to track and reward contributions before cash arrives.
    +
    +??? info "How it works (Technical Details)"
    +    When a contributor completes a task, the Team Captain approves it and 
    +    Smartup Credits are minted to the ledger. These credits represent a 
    +    future claim on treasury funds at a 1 SC = 1 EUR rate.
    +

    +

    Renders as:

    +

    The Smartup Credit System

    +

    Why it exists: We need a fair way to track and reward contributions before cash arrives.

    +
    +How it works (Technical Details) +

    When a contributor completes a task, the Team Captain approves it and +Smartup Credits are minted to the ledger. These credits represent a +future claim on treasury funds at a 1 SC = 1 EUR rate.

    +
    +

    Common Phrases

    +

    Use these standardized phrases:

    + +

    🧩 Component Library

    +

    Definition Boxes

    +

    Example Code: +

    !!! info "Smartup"
    +    A new organizational model based on collective ownership, collective 
    +    craftsmanship, and collective governance.
    +

    +

    Renders as:

    +
    +

    Smartup

    +

    A new organizational model based on collective ownership, collective +craftsmanship, and collective governance.

    +
    +
    +

    Warning Boxes

    +

    Example Code: +

    !!! warning "Experimental Phase"
    +    This process is still being tested in our micro-pilot. 
    +    Procedures may change based on learnings.
    +

    +

    Renders as:

    +
    +

    Experimental Phase

    +

    This process is still being tested in our micro-pilot. +Procedures may change based on learnings.

    +
    +
    +

    Example Boxes

    +

    Example Code: +

    !!! example "How This Works in Practice"
    +    When a developer completes a task worth 500 SC, the Team Captain 
    +    approves it, triggering an automatic ledger update via Engelbot.
    +

    +

    Renders as:

    +
    +

    How This Works in Practice

    +

    When a developer completes a task worth 500 SC, the Team Captain +approves it, triggering an automatic ledger update via Engelbot.

    +
    +
    +

    Quote Boxes

    +

    Example Code: +

    !!! quote "Our Inscription"
    +    We don't accept our reality but seek to alter it. We are not too late 
    +    or too early but precisely on time. The next big thing will be a mosaic 
    +    of small things.
    +

    +

    Renders as:

    +
    +

    Our Inscription

    +

    We don't accept our reality but seek to alter it. We are not too late +or too early but precisely on time. The next big thing will be a mosaic +of small things.

    +
    +
    +

    Tabs for Multiple Perspectives

    +

    Example Code: +

    === ":material-account: For Contributors"
    +
    +    Learn how to join the project and start earning Smartup Credits 
    +    by contributing your skills to building ONLIFE.
    +
    +=== ":material-currency-eur: For Supporters"
    +
    +    Discover how your financial support directly enables the development 
    +    of public-good technology with transparent fund allocation.
    +
    +=== ":material-cellphone: For Future Users"
    +
    +    Understand how ONLIFE will provide emergency communication when 
    +    traditional networks fail.
    +

    +

    Renders as:

    +
    +
    +
    +

    Learn how to join the project and start earning Smartup Credits +by contributing your skills to building ONLIFE.

    +
    +
    +

    Discover how your financial support directly enables the development +of public-good technology with transparent fund allocation.

    +
    +
    +

    Understand how ONLIFE will provide emergency communication when +traditional networks fail.

    +
    +
    +
    +
    +

    Expandable Details

    +

    Example Code: +

    ??? question "What are Smartup Credits?"
    +
    +    Smartup Credits (SC) are internal units that track contributions 
    +    before cash is available. 1 SC = 1 EUR claim on the treasury.
    +
    +??? tip "Pro Tip: Claiming Your First Task"
    +
    +    Start with tasks labeled "good-first-task" in Forgejo. Comment 
    +    on the issue to claim it before starting work.
    +

    +

    Renders as:

    +
    +What are Smartup Credits? +

    Smartup Credits (SC) are internal units that track contributions +before cash is available. 1 SC = 1 EUR claim on the treasury.

    +
    +
    +Pro Tip: Claiming Your First Task +

    Start with tasks labeled "good-first-task" in Forgejo. Comment +on the issue to claim it before starting work.

    +
    +
    +

    Button Styles

    +

    Example Code: +

    [Primary Action :material-arrow-right:](#){ .md-button .md-button--primary }
    +[Secondary Action](#){ .md-button }
    +[Text Link with Icon :material-open-in-new:](#)
    +

    +

    Renders as:

    +

    Primary Action +Secondary Action +Text Link with Icon

    +
    +

    Mermaid Diagrams

    +

    Example Code: +

    ```mermaid
    +graph TD
    +    A[Contributor] -->|Creates| B[Task]
    +    B -->|Completes| C[Review]
    +    C -->|Approves| D[SC Minted]
    +    D -->|Logged in| E[Ledger]
    +```
    +

    +

    Renders as:

    +
    graph TD
    +    A[Contributor] -->|Creates| B[Task]
    +    B -->|Completes| C[Review]
    +    C -->|Approves| D[SC Minted]
    +    D -->|Logged in| E[Ledger]
    +
    +
    +

    Progress Indicators

    +

    Example Code: +

    !!! abstract "Micro-Pilot Progress"
    +    :material-progress-check: **35% Complete**
    +
    +    - [x] Infrastructure deployed
    +    - [x] Core team assembled
    +    - [ ] First work cycle
    +    - [ ] Binding vote held
    +

    +

    Renders as:

    +
    +

    Micro-Pilot Progress

    +

    35% Complete

    + +
    +

    πŸ”§ Technical Formatting

    +

    Code Blocks

    +

    Always specify language for syntax highlighting.

    +

    Example Code: +

    ```python
    +def mint_credits(worker, amount):
    +    """Mint Smartup Credits for completed work."""
    +    return ledger.add_entry(worker, amount)
    +```
    +

    +

    Renders as:

    +
    def mint_credits(worker, amount):
    +    """Mint Smartup Credits for completed work."""
    +    return ledger.add_entry(worker, amount)
    +
    +
    +

    File Contents

    +

    Example Code: +

    !!! example "ledger.log"
    +    ```json
    +    {"type": "mint", "worker": "@alice", "amount": 500, "task": "#42"}
    +    ```
    +

    +

    Renders as:

    +
    +

    ledger.log

    +
    {"type": "mint", "worker": "@alice", "amount": 500, "task": "#42"}
    +
    +
    +
    +

    Terminal Commands

    +

    Example Code: +

    ```console
    +$ git clone https://smartup-zero-forgejo.fly.dev/smartup-zero/0_timeline.git
    +$ cd 0_timeline
    +$ mkdocs serve
    +INFO - Building documentation...
    +INFO - Documentation built in 2.43 seconds
    +```
    +

    +

    Renders as:

    +
    $ git clone https://smartup-zero-forgejo.fly.dev/smartup-zero/0_timeline.git
    +$ cd 0_timeline
    +$ mkdocs serve
    +INFO - Building documentation...
    +INFO - Documentation built in 2.43 seconds
    +
    +

    πŸ“Š Tables and Data

    +

    Standard Table Format

    +

    Example Code: +

    | Component | Status | Notes |
    +|-----------|--------|-------|
    +| Matrix Server | :material-check-circle: Operational | 99.9% uptime |
    +| Forgejo | :material-check-circle: Operational | v1.21.3 |
    +| Engelbot | :material-progress-wrench: In Progress | v0.1 pending |
    +

    +

    Renders as:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    ComponentStatusNotes
    Matrix Server Operational99.9% uptime
    Forgejo Operationalv1.21.3
    Engelbot In Progressv0.1 pending
    +

    🌐 Linking Strategy

    + + + + +

    Cross-References

    +

    Example Code: +

    !!! tip "Related Topics"
    +    - [The Smartup Model](../0_timeline/the-smartup-hypothesis.md)
    +    - [How to Contribute](../smartup-zero/2_workplace.md)
    +    - [Team Structure](../smartup-zero/3_teams.md)
    +

    +

    Renders as:

    +
    +

    Related Topics

    + +
    +

    βœ… Checklist for New Pages

    +

    Before publishing any new page, ensure:

    + +

    πŸš€ Quick Start Template

    +

    Copy this template when creating new pages:

    +
    **:material-icon: Page Title
    +
    +!!! info "What is this?"
    +    One-sentence explanation of what this page covers.
    +
    +**Purpose**
    +
    +Brief paragraph explaining why this matters in the Smartup Zero context.
    +
    +**Main Content**
    +
    +Your content here, following the patterns above...
    +
    +**:material-rocket-launch: Next Steps**
    +
    +What the reader should do after reading this page.
    +
    +!!! tip "Related Topics"
    +    - [Related Page 1](link)
    +    - [Related Page 2](link)
    +
    +
    +
    +

    Ready to Create Content!

    +

    Now you have all the patterns and examples needed to create consistent, +beautiful content for 0_timeline. Remember to reference +this guide whenever you're unsure about formatting or style choices.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + + + + + + + + + + + + + \ No newline at end of file diff --git a/site/stylesheets/extra.css b/site/stylesheets/extra.css index f8b6d9a..6352251 100644 --- a/site/stylesheets/extra.css +++ b/site/stylesheets/extra.css @@ -178,3 +178,15 @@ body:not(.has-hero) .md-content__inner { padding-top: 3.5rem !important; /* Smaller header on mobile */ } } + +/* Force inline admonitions to work on desktop */ +@media screen and (min-width: 76.25em) { + .md-typeset .admonition.inline, + .md-typeset details.inline { + float: right; + margin-left: 1rem; + margin-top: 0; + max-width: 20rem; + } +} +