Skip to content
This repository has been archived by the owner on Nov 23, 2024. It is now read-only.

Fix admonitions #16

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/features/timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,19 @@ layout:

# ⌛ Timeline

> [!IMPORTANT]
> The timeline feature has been temporarily hidden from the UI while we focus our alpha work on the Virtual Branch functionality. It will come back very soon. :pray:
{% hint style="warning" %}
The timeline feature has been temporarily hidden from the UI while we focus our alpha work on the Virtual Branch functionality. It will come back very soon. :pray:
{% endhint %}

Another feature of GitButler is the project timeline. This tool allows you to find any version of any file that has ever existed in your project from the moment you downloaded GitButler.

## Always Watching

When you add a project to GitButler, we will always be in the background, watching the directory like a hawk. Any files that you change that are not in your `.gitignore` file will be automatically saved every time you change them.

> [!NOTE]
> The actual implementation of this is that we store CRDT data for all observed file changes inside your `.git` directory under `gb-[long-id-number]`. When we see you've stopped making changes for a few minutes, we flush all of that information to a meta-commit and update a hidden Git reference which you can find by running `git show-ref | grep gitbutler`. If you sign up for GitButler Cloud, we push that data to our servers so your working directory history is backed up.
{% hint style="info" %}
The actual implementation of this is that we store CRDT data for all observed file changes inside your `.git` directory under `gb-[long-id-number]`. When we see you've stopped making changes for a few minutes, we flush all of that information to a meta-commit and update a hidden Git reference which you can find by running `git show-ref | grep gitbutler`. If you sign up for GitButler Cloud, we push that data to our servers so your working directory history is backed up.
{% endhint %}

These changes allow us to reconstruct what your working directory looked like at any point in time. You can see visualizations of this data on your project homepage and you can drill into any day or file to play back the changes. You can use this to remind yourself what you did, find previous versions of files that were never committed, revert sections or code you want to go back to, etc.

Expand Down
17 changes: 10 additions & 7 deletions docs/features/virtual-branches/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ Virtual branches are just like normal Git branches, except that you can work on
</figure>
</div>

> [!WARNING]
> You cannot use both GitButler virtual branches and normal Git branching commands at the same time, you will have to "commit" to one approach or the other.
{% hint style="warning" %}
You cannot use both GitButler virtual branches and normal Git branching commands at the same time, you will have to "commit" to one approach or the other.
{% endhint %}

The reason is that stock Git can only handle one branch at a time, it does not have tooling to use or understand multiple, so most commands having to do with the index or HEAD or branching (`commit`, `branch`, `checkout`, etc) may behave unexpectedly. Most importantly, do not use normal Git commit tooling or other GUIs.&#x20;

> [!TIP]
> To understand why and how to get out of this, please read our [integration-branch.md](integration-branch.md) docs.
{% hint style="info" %}
To understand why and how to get out of this, please read our [integration-branch.md](integration-branch.md) docs.
{% endhint %}

## Base Branch

Expand Down Expand Up @@ -83,9 +85,10 @@ Eventually you will have work merged into the branch you chose as your base bran

Upstream work will automatically be shown in your sidebar in the "Trunk" section. When you click "Merge into common base" (or the "Update" button next to your "Applied Branches" section), we will attempt to integrate that work with your existing virtual branches. Each branch, applied or unapplied, will try to be updated with the new work.

> [!NOTE]
> We will attempt to rebase any commits in your virtual branches on top of new work (similar to running a `git pull --rebase` on each branch).
> However, if you already have commits in your branch, we have to create a merge commit to get them up to date.
{% hint style="info" %}
We will attempt to rebase any commits in your virtual branches on top of new work (similar to running a `git pull --rebase` on each branch).
However, if you already have commits in your branch, we have to create a merge commit to get them up to date.
{% endhint %}

If we cannot update a branch because of merge conflicts, we will unapply the branch automatically and leave it in an unmerged state. You can identify these branches with the blue dot next to them in your branch listing.

Expand Down