Documentation

Docs

A simple custom docs area now, with room for versioned documentation later.

cheatsheet / current

Ways To Push and Sync

This means: **when a pull needs reconciliation, use merge, not rebase**. That does **not** mean “always create a merge commit.” If a fast-forward is possibl

cheatsheetgit

cheatsheet / current

Architecture Diagram

Use Mermaid architecture-beta when you want to show systems, groups, services, and directional relationships at a higher level than a flowchart.

cheatsheetmermaid

cheatsheet / current

Block Diagram

Use Mermaid block-beta when you want a clean block layout without the extra semantics of flowcharts or architecture diagrams.

cheatsheetmermaid

cheatsheet / current

Class Diagram

Use Mermaid classDiagram to show classes, interfaces, inheritance, composition, and associations in object-oriented designs.

cheatsheetmermaid

cheatsheet / current

Entity Relationship Diagram

Use Mermaid erDiagram to model tables, entities, fields, keys, and cardinality.

cheatsheetmermaid

cheatsheet / current

Flowchart

Use Mermaid flowchart for process logic, branching, pipelines, decision trees, and system flows.

cheatsheetmermaid

cheatsheet / current

Gantt Chart

Use Mermaid gantt to show work over time, dependencies, milestones, and project scheduling.

cheatsheetmermaid

cheatsheet / current

Git Graph

Use Mermaid gitGraph to explain branching, merging, hotfixes, and release flow.

cheatsheetmermaid

cheatsheet / current

Kanban Board

Use Mermaid kanban to show work items across columns like backlog, in progress, blocked, and done.

cheatsheetmermaid

cheatsheet / current

Mindmap

Use Mermaid mindmap to brainstorm, outline, decompose ideas, or organize topics hierarchically.

cheatsheetmermaid

cheatsheet / current

Packet Diagram

Use Mermaid packet-beta to describe packet structures, nested headers, and byte-oriented layouts.

cheatsheetmermaid

cheatsheet / current

Pie Chart

Use Mermaid pie when you need a quick proportional snapshot of categories.

cheatsheetmermaid

cheatsheet / current

Quadrant Chart

Use Mermaid quadrantChart to place items on two axes such as impact vs effort or value vs risk.

cheatsheetmermaid

cheatsheet / current

Radar Chart

Use Mermaid radar-beta to compare multiple options across the same set of dimensions.

cheatsheetmermaid

cheatsheet / current

Requirement Diagram

Use Mermaid requirementDiagram to document requirements, relationships, traceability, and verification links.

cheatsheetmermaid

cheatsheet / current

Sankey Diagram

Use Mermaid sankey-beta to show quantities flowing from one category to another.

cheatsheetmermaid

cheatsheet / current

Sequence Diagram

Use Mermaid sequenceDiagram to show interactions over time between people, systems, and services.

cheatsheetmermaid

cheatsheet / current

State Diagram

Use Mermaid stateDiagram-v2 to show how something moves between states based on events or conditions.

cheatsheetmermaid

cheatsheet / current

Timeline

Use Mermaid timeline to present milestones or events in chronological order.

cheatsheetmermaid

cheatsheet / current

Treemap

Use Mermaid treemap-beta to show hierarchical categories sized by value.

cheatsheetmermaid

cheatsheet / current

User Journey

Use Mermaid journey to describe a user or customer moving through steps, along with satisfaction or sentiment at each stage.

cheatsheetmermaid

cheatsheet / current

XY Chart

Use Mermaid xychart-beta to show line charts or bar charts with explicit axes.

cheatsheetmermaid

cheatsheet / current

ZenUML

Use Mermaid zenuml when you want a more code-like sequence description, especially for method-call style interactions.

cheatsheetmermaid

cheatsheet / current

Brand Cheat Sheet

Use these frontmatter classes to change the feel of a note.

cheatsheetobsidian

cheatsheet / current

Callouts Cheat Sheet

These examples are meant to be copied directly into a note.

cheatsheetobsidian

cheatsheet / current

Images Cheat Sheet

These patterns work with the Besso brand snippets.

cheatsheetobsidian

guide / current

Content Model

How this starter thinks about collections, cross-listing, and Obsidian source metadata.

architecturecontent

cheatsheet / current

Architecture Diagram

a cheatsheet.

mermaidarchitecturecheatsheet

guide / current

Example Guide

A sample guide page for The Curious Boomer docs.

guidedocs

reference / current

Example Reference

A sample reference page for The Curious Boomer docs.

referencedocs

guide / current

The Curious Boomer Docs

A starting place for guides, references, cheatsheets, and experiments promoted into the site.

docspublishing