git-nested 1.1.1__tar.gz → 1.2.0__tar.gz

{git_nested-1.1.1 → git_nested-1.2.0}/.github/workflows/build-binary.yml

@@ -23,10 +23,10 @@ on:
         required: false
         default: git-nested-binary
       runs-on:
-        description: 'Runner to build on -- ubuntu-latest, macos-latest, windows-latest'
+        description: 'Runner to build on -- ubuntu-26.04, macos-latest, windows-latest'
         type: string
         required: false
-        default: ubuntu-latest
+        default: ubuntu-26.04
       container:
         description: 'Container to build inside (Linux only). Empty: build on the runner itself.'
         type: string
@@ -54,7 +54,7 @@ jobs:
     # For Linux the default is almalinux:8, and that is a portability
     # decision, not a convenience one: a PyInstaller binary links the glibc of
     # the machine that built it, and glibc is only backward compatible, so
-    # built on ubuntu-latest it would refuse to start on anything older than
+    # built on ubuntu-26.04 it would refuse to start on anything older than
     # that runner. AlmaLinux 8 has glibc 2.28, the oldest that still runs the
     # node20 the actions below need, which covers every distro from Ubuntu
     # 20.04 / Debian 10 / Fedora 29 / RHEL 8 onwards. glibc-based distros only
@@ -135,3 +135,5 @@ jobs:
             dist/*.tar.xz
             dist/*.zip
           if-no-files-found: error
+          # main keeps its builds for a month, branch and PR builds only for two days.
+          retention-days: ${{ github.ref == 'refs/heads/main' && 30 || 2 }}

git_nested-1.2.0/.github/workflows/docs.yml

@@ -0,0 +1,64 @@
+name: Docs
+
+# Builds doc/ (see doc/conf.py) with Sphinx. On pull requests it only
+# builds, so a broken page fails the check. On main it also publishes the
+# site to the gh_pages branch, which GitHub Pages serves.
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ['**']
+  # by hand: 'Run workflow' in the Actions tab, or `gh workflow run docs.yml`
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  build:
+    runs-on: ubuntu-26.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+        with:
+          # doc/conf.py shows the version from `git describe`, which needs the tags.
+          fetch-depth: 0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          python-version: '3.14'
+          enable-cache: true
+      - name: Setup project
+        run: uv sync --frozen
+      - name: Build docs
+        run: uv run poe docs
+      - name: Upload docs
+        if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
+        uses: actions/upload-artifact@v7
+        with:
+          name: docs-html
+          path: doc/_build/html
+          include-hidden-files: true
+
+  # A job of its own, so only this one can write to the repository.
+  # Only main is published, also when the workflow is started by hand.
+  publish:
+    if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-26.04
+    permissions:
+      contents: write
+    steps:
+      - name: Download docs
+        uses: actions/download-artifact@v8
+        with:
+          name: docs-html
+          path: site
+      - name: Publish docs
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh_pages
+          publish_dir: site
+          force_orphan: true

git_nested-1.2.0/.github/workflows/prune-artifacts.yml

@@ -0,0 +1,57 @@
+name: Prune artifacts
+
+# Caps how many binary artifacts pile up against the repository's Actions
+# storage quota, per artifact name and branch: main keeps its newest 3 builds,
+# every other branch (PR branches included) only its newest 1. The upload
+# step's retention-days (30 days main, 2 days elsewhere) is only an upper
+# bound; this caps the count as well.
+#
+# Runs once the workflows that build the artifacts have finished, so the
+# artifact of the run that triggered it already exists and the caps hold
+# exactly. workflow_run only fires for workflow files on the default branch,
+# so changes to this file take effect once merged.
+on:
+  workflow_run:
+    workflows:
+    - Run Tests
+    - Release binary
+    types:
+    - completed
+  # on-demand -- 'Run workflow' in the Actions tab, or `gh workflow run prune-artifacts.yml`
+  workflow_dispatch:
+    inputs:
+      keep:
+        description: 'How many of the newest main artifacts to keep per artifact name (other branches keep 1)'
+        type: number
+        default: 3
+
+permissions:
+  actions: write
+
+# two prunes at once would only race each other deleting the same artifacts.
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: false
+
+jobs:
+  prune:
+    runs-on: ubuntu-26.04
+    steps:
+      - name: Delete all but the newest builds
+        env:
+          GH_TOKEN: ${{ github.token }}
+          REPO: ${{ github.repository }}
+          KEEP: ${{ inputs.keep || 3 }}
+        run: |
+          # Per artifact name and branch ("git-nested-binary-ci-linux" on
+          # "main", ...), newest first; everything after the first $KEEP on
+          # main, or after the first 1 on any other branch, is deleted. Other
+          # artifacts (dist) are not touched.
+          gh api --paginate "repos/$REPO/actions/artifacts?per_page=100" \
+              --jq '.artifacts[] | select(.expired == false) | select(.name | startswith("git-nested-binary-")) | [.name + " " + .workflow_run.head_branch, .created_at, .id, .workflow_run.head_branch] | @tsv' \
+            | sort -t $'\t' -k1,1 -k2,2r \
+            | awk -F'\t' -v keep="$KEEP" '{ if (++n[$1] > ($4 == "main" ? keep : 1)) print $3, $1 }' \
+            | while read -r id name; do
+                echo "delete $name (artifact $id)"
+                gh api -X DELETE "repos/$REPO/actions/artifacts/$id"
+              done

{git_nested-1.1.1 → git_nested-1.2.0}/.github/workflows/publish.yml

@@ -6,14 +6,14 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-26.04
     steps:
       - name: Checkout code
         uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v10.3.0
         with:
           python-version: '3.13'
           enable-cache: true
@@ -29,7 +29,7 @@ jobs:
 
   publish:
     needs: build
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-26.04
     environment:
       name: pypi
       url: https://pypi.org/project/git-nested/

{git_nested-1.1.1 → git_nested-1.2.0}/.github/workflows/release-binary.yml

@@ -47,7 +47,7 @@ jobs:
           # Intel macOS is deliberately absent: those runners are gone, and
           # the arm64 binary is what a current Mac needs.
           - target: linux
-            runs-on: ubuntu-latest
+            runs-on: ubuntu-26.04
             container: almalinux:8
           - target: macos
             runs-on: macos-latest
@@ -76,7 +76,7 @@ jobs:
   # and has to drive a real nested repo end to end there.
   verify:
     needs: build
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-26.04
     strategy:
       fail-fast: false
       matrix:
@@ -163,7 +163,7 @@ jobs:
     needs: [build, test, verify]
     # nothing to attach when workflow_dispatch ran without a tag
     if: github.event_name == 'release' || inputs.tag != ''
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-26.04
     permissions:
       contents: write
     steps:

{git_nested-1.1.1 → git_nested-1.2.0}/.github/workflows/test-binary.yml

@@ -28,7 +28,7 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-26.04
     steps:
       - uses: actions/checkout@v7
         with:
@@ -38,7 +38,7 @@ jobs:
           # tags of this checkout.
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v10.3.0
         with:
           python-version: '3.13'
           enable-cache: true

{git_nested-1.1.1 → git_nested-1.2.0}/.github/workflows/test.yml

@@ -6,13 +6,14 @@ on:
   pull_request:
     branches: ['**']
 
-# One run per branch/PR at a time -- a new commit cancels whatever this
-# workflow is still running for the same ref. Not on main: every push there
-# is a merge, and each one should run to completion rather than being
-# canceled by the next.
+# One run per branch/PR at a time. On a PR a newer push cancels the run in
+# progress: only the newest commit's results matter there, and waiting for a
+# superseded run would hold its checks back by the length of a whole run. On
+# main every run finishes, so each merged commit keeps its full results (a
+# newer push waits; only the newest waiting run is kept).
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
-  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 
 jobs:
   # Builds the standalone executable with the very script the release uses
@@ -29,7 +30,7 @@ jobs:
           # Intel macOS is deliberately absent: those runners are gone, and
           # the arm64 binary is what a current Mac needs.
           - target: linux
-            runs-on: ubuntu-latest
+            runs-on: ubuntu-26.04
             container: almalinux:8
           - target: macos
             runs-on: macos-latest
@@ -56,9 +57,17 @@ jobs:
 
   test:
     runs-on: ${{ matrix.os }}
+    # The steps are written for bash; on windows-latest the default would be
+    # PowerShell. Git for Windows ships bash on every runner.
+    defaults:
+      run:
+        shell: bash
     strategy:
+      # One OS failing must not cancel the others: a Windows-only break should
+      # still show whether Linux and macOS pass.
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-26.04, macos-latest, windows-latest]
         python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
 
     steps:
@@ -70,7 +79,7 @@ jobs:
           # checkout.
           fetch-depth: 0
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v10.3.0
         with:
           python-version: ${{ matrix.python-version }}
           enable-cache: true
@@ -86,17 +95,19 @@ jobs:
       - name: Run poe all
         run: uv run poe all
       - name: Upload coverage reports to Codecov
-        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.14'
+        if: matrix.os == 'ubuntu-26.04' && matrix.python-version == '3.14'
         uses: codecov/codecov-action@v7
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
       - name: Upload test results to Codecov
         if: ${{ !cancelled() }}
-        uses: codecov/test-results-action@v1
+        uses: codecov/codecov-action@v7
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+          report_type: test_results
+          files: junit.xml
       - name: SonarCloud Scan
-        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.14'
+        if: matrix.os == 'ubuntu-26.04' && matrix.python-version == '3.14'
         uses: SonarSource/sonarqube-scan-action@v8
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

{git_nested-1.1.1 → git_nested-1.2.0}/.gitignore

@@ -6,6 +6,7 @@ __pycache__
 *.egg-info/
 dist/
 build/
+doc/_build/
 .pytest_cache/
 .coverage
 htmlcov/

{git_nested-1.1.1 → git_nested-1.2.0}/.pre-commit-config.yaml

@@ -55,9 +55,6 @@ repos:
 
 
 # Configuration
-default_language_version:
-  python: python3.12
-
 # Minimum pre-commit version -- matches the floor pyproject.toml's `lint`
 # dependency group pins.
 minimum_pre_commit_version: '4.0.0'

git_nested-1.2.0/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing to git-nested
+
+Thank you for helping!
+
+- [Development](doc/contributing/development.md): setup, tests, checks and
+  commit messages.
+- [Documentation](doc/contributing/documentation.md): how to write and build
+  the docs.
+- [Architecture](doc/architecture/index.md): how the code is built.
+
+The short version:
+
+```bash
+uv sync          # install everything
+uv run poe all   # every check CI runs
+```
+
+For security problems, see [SECURITY.md](SECURITY.md). Do not open a public
+issue.

git_nested-1.2.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: git-nested
+Version: 1.2.0
+Summary: Git Submodule Alternative
+Author-email: Thorsten Klein <thorsten.klein.git@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/thorsten-klein/git-nested
+Project-URL: Documentation, https://thorsten-klein.github.io/git-nested/
+Project-URL: Repository, https://github.com/thorsten-klein/git-nested
+Project-URL: Issues, https://github.com/thorsten-klein/git-nested/issues
+Keywords: git,nested,submodule,nested
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML<7,>=6.0
+Dynamic: license-file
+
+# git-nested
+
+> An alternative to git-submodule and git-subtree for managing nested repositories.
+
+[![Test](https://github.com/thorsten-klein/git-nested/actions/workflows/test.yml/badge.svg)](https://github.com/thorsten-klein/git-nested/actions/workflows/test.yml)
+[![Docs](https://github.com/thorsten-klein/git-nested/actions/workflows/docs.yml/badge.svg)](https://thorsten-klein.github.io/git-nested/)
+[![codecov](https://codecov.io/gh/thorsten-klein/git-nested/branch/main/graph/badge.svg)](https://codecov.io/gh/thorsten-klein/git-nested)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=thorsten-klein_git-nested&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=thorsten-klein_git-nested)
+[![PyPI](https://img.shields.io/pypi/v/git-nested.svg)](https://pypi.org/project/git-nested/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+
+**📖 Documentation: <https://thorsten-klein.github.io/git-nested/>**
+
+## What is git-nested?
+
+git-nested puts another git repository into a folder of your repository.
+The files are ordinary files in ordinary commits. You can still pull new
+changes from the other repository, and push your changes back to it.
+
+```bash
+git nested clone https://github.com/user/lib ext/lib   # copy it in
+git nested pull ext/lib                                # get new upstream changes
+git nested push ext/lib                                # send your changes back
+git nested status                                      # see where everything stands
+```
+
+A small `.gitnested` file in the folder remembers the URL, the branch and
+the upstream commit. So the commands stay short.
+
+## Why git-nested?
+
+- **Self-contained.** Your repository has all files. A plain `git clone`
+  gets everything. No access to the other repositories is needed.
+- **Simple.** The commands feel like git.
+- **Clean history.** By default one pull is one commit.
+- **Flexible.** Each branch can have its nested repositories in another
+  state.
+- **Safe to try.** Everything is a normal commit. `git reset` undoes it.
+
+Only people who pull or push nested repositories need git-nested. See
+[Compared to submodule and subtree](https://github.com/thorsten-klein/git-nested/blob/main/doc/concepts/comparison.md).
+
+## Install
+
+```bash
+pip install git-nested
+```
+
+git 2.23 and Python 3.10 or newer are needed. There is also a
+[standalone executable](https://github.com/thorsten-klein/git-nested/blob/main/doc/introduction/install.md#standalone-executable)
+that needs no Python. See [Install git-nested](https://github.com/thorsten-klein/git-nested/blob/main/doc/introduction/install.md)
+for all ways, shell completion and the manual page.
+
+## Documentation
+
+The full documentation is in [`doc/`](https://github.com/thorsten-klein/git-nested/blob/main/doc/README.md), and online at
+<https://thorsten-klein.github.io/git-nested/>.
+
+- [About git-nested](https://github.com/thorsten-klein/git-nested/blob/main/doc/introduction/index.md)
+- [git-nested in 5 minutes](https://github.com/thorsten-klein/git-nested/blob/main/doc/quickstart/05-minutes.md)
+- [Everyday tasks](https://github.com/thorsten-klein/git-nested/blob/main/doc/quickstart/everyday.md)
+- [How it works](https://github.com/thorsten-klein/git-nested/blob/main/doc/concepts/how-it-works.md)
+- [Command reference](https://github.com/thorsten-klein/git-nested/blob/main/doc/cli/index.md)
+- [The `.gitnested` file](https://github.com/thorsten-klein/git-nested/blob/main/doc/configuration/gitnested-file.md)
+- [Guides](https://github.com/thorsten-klein/git-nested/blob/main/doc/README.md#guides): conflicts, partial upstreams, pins,
+  submodules and more
+
+Help on the command line:
+
+```bash
+git nested --help          # the manual page
+git nested pull --help     # one command: what it does, its options, examples
+```
+
+## Contributing
+
+Pull requests are welcome. See [Development](https://github.com/thorsten-klein/git-nested/blob/main/doc/contributing/development.md)
+for the setup and the checks. The short version:
+
+```bash
+uv sync          # install everything
+uv run poe all   # every check CI runs
+```
+
+Report security problems as described in [SECURITY.md](https://github.com/thorsten-klein/git-nested/blob/main/SECURITY.md).
+
+## Authors
+
+**git-nested:**
+- **Thorsten Klein** - Python rewrite and enhancements
+
+**Original [git-subrepo](https://github.com/ingydotnet/git-subrepo) authors:**
+- **Ingy döt Net** - Original concept and implementation
+- **Magnus Carlsson** - Contributor
+- **Austin Morgan** - Contributor
+
+## License
+
+MIT. See [LICENSE](https://github.com/thorsten-klein/git-nested/blob/main/LICENSE).
+
+## Acknowledgments
+
+This project is based on [git-subrepo](https://github.com/ingydotnet/git-subrepo) by Ingy döt Net.
+git-nested is a Python rewrite with some modified features and improvements.

git_nested-1.2.0/README.md

@@ -0,0 +1,105 @@
+# git-nested
+
+> An alternative to git-submodule and git-subtree for managing nested repositories.
+
+[![Test](https://github.com/thorsten-klein/git-nested/actions/workflows/test.yml/badge.svg)](https://github.com/thorsten-klein/git-nested/actions/workflows/test.yml)
+[![Docs](https://github.com/thorsten-klein/git-nested/actions/workflows/docs.yml/badge.svg)](https://thorsten-klein.github.io/git-nested/)
+[![codecov](https://codecov.io/gh/thorsten-klein/git-nested/branch/main/graph/badge.svg)](https://codecov.io/gh/thorsten-klein/git-nested)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=thorsten-klein_git-nested&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=thorsten-klein_git-nested)
+[![PyPI](https://img.shields.io/pypi/v/git-nested.svg)](https://pypi.org/project/git-nested/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+
+**📖 Documentation: <https://thorsten-klein.github.io/git-nested/>**
+
+## What is git-nested?
+
+git-nested puts another git repository into a folder of your repository.
+The files are ordinary files in ordinary commits. You can still pull new
+changes from the other repository, and push your changes back to it.
+
+```bash
+git nested clone https://github.com/user/lib ext/lib   # copy it in
+git nested pull ext/lib                                # get new upstream changes
+git nested push ext/lib                                # send your changes back
+git nested status                                      # see where everything stands
+```
+
+A small `.gitnested` file in the folder remembers the URL, the branch and
+the upstream commit. So the commands stay short.
+
+## Why git-nested?
+
+- **Self-contained.** Your repository has all files. A plain `git clone`
+  gets everything. No access to the other repositories is needed.
+- **Simple.** The commands feel like git.
+- **Clean history.** By default one pull is one commit.
+- **Flexible.** Each branch can have its nested repositories in another
+  state.
+- **Safe to try.** Everything is a normal commit. `git reset` undoes it.
+
+Only people who pull or push nested repositories need git-nested. See
+[Compared to submodule and subtree](https://github.com/thorsten-klein/git-nested/blob/main/doc/concepts/comparison.md).
+
+## Install
+
+```bash
+pip install git-nested
+```
+
+git 2.23 and Python 3.10 or newer are needed. There is also a
+[standalone executable](https://github.com/thorsten-klein/git-nested/blob/main/doc/introduction/install.md#standalone-executable)
+that needs no Python. See [Install git-nested](https://github.com/thorsten-klein/git-nested/blob/main/doc/introduction/install.md)
+for all ways, shell completion and the manual page.
+
+## Documentation
+
+The full documentation is in [`doc/`](https://github.com/thorsten-klein/git-nested/blob/main/doc/README.md), and online at
+<https://thorsten-klein.github.io/git-nested/>.
+
+- [About git-nested](https://github.com/thorsten-klein/git-nested/blob/main/doc/introduction/index.md)
+- [git-nested in 5 minutes](https://github.com/thorsten-klein/git-nested/blob/main/doc/quickstart/05-minutes.md)
+- [Everyday tasks](https://github.com/thorsten-klein/git-nested/blob/main/doc/quickstart/everyday.md)
+- [How it works](https://github.com/thorsten-klein/git-nested/blob/main/doc/concepts/how-it-works.md)
+- [Command reference](https://github.com/thorsten-klein/git-nested/blob/main/doc/cli/index.md)
+- [The `.gitnested` file](https://github.com/thorsten-klein/git-nested/blob/main/doc/configuration/gitnested-file.md)
+- [Guides](https://github.com/thorsten-klein/git-nested/blob/main/doc/README.md#guides): conflicts, partial upstreams, pins,
+  submodules and more
+
+Help on the command line:
+
+```bash
+git nested --help          # the manual page
+git nested pull --help     # one command: what it does, its options, examples
+```
+
+## Contributing
+
+Pull requests are welcome. See [Development](https://github.com/thorsten-klein/git-nested/blob/main/doc/contributing/development.md)
+for the setup and the checks. The short version:
+
+```bash
+uv sync          # install everything
+uv run poe all   # every check CI runs
+```
+
+Report security problems as described in [SECURITY.md](https://github.com/thorsten-klein/git-nested/blob/main/SECURITY.md).
+
+## Authors
+
+**git-nested:**
+- **Thorsten Klein** - Python rewrite and enhancements
+
+**Original [git-subrepo](https://github.com/ingydotnet/git-subrepo) authors:**
+- **Ingy döt Net** - Original concept and implementation
+- **Magnus Carlsson** - Contributor
+- **Austin Morgan** - Contributor
+
+## License
+
+MIT. See [LICENSE](https://github.com/thorsten-klein/git-nested/blob/main/LICENSE).
+
+## Acknowledgments
+
+This project is based on [git-subrepo](https://github.com/ingydotnet/git-subrepo) by Ingy döt Net.
+git-nested is a Python rewrite with some modified features and improvements.

git_nested-1.2.0/doc/README.md

@@ -0,0 +1,60 @@
+# git-nested documentation
+
+This folder is the full documentation of git-nested. You can read it here
+on GitHub, or as a website at <https://thorsten-klein.github.io/git-nested/>.
+
+## Introduction
+
+- **[`introduction/index.md`](introduction/index.md)**: what git-nested is
+  and which problem it solves.
+- **[`introduction/install.md`](introduction/install.md)**: all ways to
+  install it.
+
+## Quickstart
+
+- **[`quickstart/05-minutes.md`](quickstart/05-minutes.md)**: a hands-on
+  walk through with two local repositories.
+- **[`quickstart/everyday.md`](quickstart/everyday.md)**: the commands you
+  need most days.
+
+## Concepts
+
+- **[`concepts/glossary.md`](concepts/glossary.md)**: every word git-nested
+  uses, in short.
+- **[`concepts/how-it-works.md`](concepts/how-it-works.md)**: what happens
+  inside a clone, a pull and a push.
+- **[`concepts/comparison.md`](concepts/comparison.md)**: git-nested next to
+  git submodule and git subtree.
+
+## `git nested` command
+
+- **[`cli/index.md`](cli/index.md)**: the options all commands share, and a
+  list of all commands. Each command has its own page in [`cli/`](cli/).
+- **[`cli/environment-variables.md`](cli/environment-variables.md)**: the
+  environment variables git-nested reads.
+
+## Configuration
+
+- **[`configuration/gitnested-file.md`](configuration/gitnested-file.md)**:
+  every field of the `.gitnested` file.
+- **[`configuration/git-config.md`](configuration/git-config.md)**: the
+  `git config` settings git-nested reads and writes.
+
+## Guides
+
+- **[`guides/`](guides/)**: one page per task, such as resolving conflicts,
+  nesting a part of upstream or pinning a release.
+
+## Architecture
+
+- **[`architecture/index.md`](architecture/index.md)**: how the code is
+  built.
+- **[`architecture/diagrams.md`](architecture/diagrams.md)**: the git
+  commands each command runs.
+
+## Contributing
+
+- **[`contributing/development.md`](contributing/development.md)**: how to
+  work on git-nested.
+- **[`contributing/documentation.md`](contributing/documentation.md)**: how
+  to write and build these docs.