# git-tips/tips architecture

> Architecture diagram of the GitHub repository git-tips/tips, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/git-tips/tips
- Repository: https://github.com/git-tips/tips

## Overview

git-tips is a curated Git command reference, not a runtime application. Readers browse the generated README catalog or the topic-organized Markdown guides; the README also points to the interactive documentation. The source index shows that build-readme.js consumes tips.json to generate README.md, but the generator itself is content tooling rather than a product component. The available excerpts do not show how the guides relate to tips.json, so no connection between them is inferred.

Main entry points: [`README.md`](https://github.com/git-tips/tips/blob/master/README.md) (README catalog), [`tips.json`](https://github.com/git-tips/tips/blob/master/tips.json) (Tip entries), [`docs/basic-operations.md`](https://github.com/git-tips/tips/blob/master/docs/basic-operations.md) (Basic operations), [`docs/branching.md`](https://github.com/git-tips/tips/blob/master/docs/branching.md) (Branching)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_catalog["Tip catalog"]
  node_catalog_data[("Tip entries<br/>[tips.json]")]
  node_readme["README catalog<br/>[README.md]"]
end

subgraph group_guides["Git guides"]
  node_basic["Basic operations"]
  node_branching["Branching<br/>[branching.md]"]
  node_history["Log and history<br/>[log-and-history.md]"]
  node_merging["Merging and rebasing"]
  node_misc["Miscellaneous<br/>[miscellaneous.md]"]
  node_remotes["Remotes<br/>[remotes.md]"]
  node_setup["Setup and config"]
  node_stashing["Stashing<br/>[stashing.md]"]
  node_submodules["Submodules and subtrees"]
  node_tagging["Tagging<br/>[tagging.md]"]
  node_undoing["Undoing changes<br/>[undoing-changes.md]"]
end

node_reader(("Reader"))

node_catalog_data -->|"generates"| node_readme
node_reader -->|"browses"| node_readme
node_reader -.->|"reads"| node_basic
node_reader -.->|"reads"| node_branching
node_reader -.->|"reads"| node_history
node_reader -.->|"reads"| node_merging
node_reader -.->|"reads"| node_misc
node_reader -.->|"reads"| node_remotes
node_reader -.->|"reads"| node_setup
node_reader -.->|"reads"| node_stashing
node_reader -.->|"reads"| node_submodules
node_reader -.->|"reads"| node_tagging
node_reader -.->|"reads"| node_undoing

click node_catalog_data "https://github.com/git-tips/tips/blob/master/tips.json"
click node_readme "https://github.com/git-tips/tips/blob/master/README.md"
click node_basic "https://github.com/git-tips/tips/blob/master/docs/basic-operations.md"
click node_branching "https://github.com/git-tips/tips/blob/master/docs/branching.md"
click node_history "https://github.com/git-tips/tips/blob/master/docs/log-and-history.md"
click node_merging "https://github.com/git-tips/tips/blob/master/docs/merging-and-rebasing.md"
click node_misc "https://github.com/git-tips/tips/blob/master/docs/miscellaneous.md"
click node_remotes "https://github.com/git-tips/tips/blob/master/docs/remotes.md"
click node_setup "https://github.com/git-tips/tips/blob/master/docs/setup-and-config.md"
click node_stashing "https://github.com/git-tips/tips/blob/master/docs/stashing.md"
click node_submodules "https://github.com/git-tips/tips/blob/master/docs/submodules-and-subtrees.md"
click node_tagging "https://github.com/git-tips/tips/blob/master/docs/tagging.md"
click node_undoing "https://github.com/git-tips/tips/blob/master/docs/undoing-changes.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_catalog_data,node_readme toneBlue
class node_basic,node_branching,node_history,node_merging,node_misc,node_remotes,node_setup,node_stashing,node_submodules,node_tagging,node_undoing toneAmber
class node_reader toneIndigo
```

## Components

### Tip catalog

- [Tip entries](https://github.com/git-tips/tips/blob/master/tips.json): `tips.json`
- [README catalog](https://github.com/git-tips/tips/blob/master/README.md): `README.md`

### Git guides

- [Basic operations](https://github.com/git-tips/tips/blob/master/docs/basic-operations.md): `docs/basic-operations.md`
- [Branching](https://github.com/git-tips/tips/blob/master/docs/branching.md): `docs/branching.md`
- [Log and history](https://github.com/git-tips/tips/blob/master/docs/log-and-history.md): `docs/log-and-history.md`
- [Merging and rebasing](https://github.com/git-tips/tips/blob/master/docs/merging-and-rebasing.md): `docs/merging-and-rebasing.md`
- [Miscellaneous](https://github.com/git-tips/tips/blob/master/docs/miscellaneous.md): `docs/miscellaneous.md`
- [Remotes](https://github.com/git-tips/tips/blob/master/docs/remotes.md): `docs/remotes.md`
- [Setup and config](https://github.com/git-tips/tips/blob/master/docs/setup-and-config.md): `docs/setup-and-config.md`
- [Stashing](https://github.com/git-tips/tips/blob/master/docs/stashing.md): `docs/stashing.md`
- [Submodules and subtrees](https://github.com/git-tips/tips/blob/master/docs/submodules-and-subtrees.md): `docs/submodules-and-subtrees.md`
- [Tagging](https://github.com/git-tips/tips/blob/master/docs/tagging.md): `docs/tagging.md`
- [Undoing changes](https://github.com/git-tips/tips/blob/master/docs/undoing-changes.md): `docs/undoing-changes.md`

### Other components

- **Reader**

## Connections

- Tip entries → README catalog: generates
- Reader → README catalog: browses (evidence: `README.md`)
- Reader → Basic operations: reads
- Reader → Branching: reads
- Reader → Log and history: reads
- Reader → Merging and rebasing: reads
- Reader → Miscellaneous: reads
- Reader → Remotes: reads
- Reader → Setup and config: reads
- Reader → Stashing: reads
- Reader → Submodules and subtrees: reads
- Reader → Tagging: reads
- Reader → Undoing changes: reads
