From cd5e7316f1faea612892419584a0f97bf2243344 Mon Sep 17 00:00:00 2001 From: Benjamin Tan Date: Sat, 6 Sep 2025 01:02:47 +0800 Subject: [PATCH] docs: use relative links to Markdown files instead of linking to GitHub This allows links to point to other pages in the generated mkdocs documentation output instead of pointing to external GitHub URLs. --- docs/git-compatibility.md | 4 ++-- docs/github.md | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/git-compatibility.md b/docs/git-compatibility.md index 7796a4c05..6358c3f01 100644 --- a/docs/git-compatibility.md +++ b/docs/git-compatibility.md @@ -49,7 +49,7 @@ a comparison with Git, including how workflows are different, see the * **Staging area: Kind of.** The staging area will be ignored. For example, `jj diff` will show a diff from the Git HEAD to the working copy. There are [ways of fulfilling your use cases without a staging - area](https://github.com/jj-vcs/jj/blob/main/docs/git-comparison.md#the-index). + area](git-comparison.md#the-index). * **Garbage collection: Yes.** It should be safe to run `git gc` in the Git repo, but it's not tested, so it's probably a good idea to make a backup of the whole workspace first. There's [no garbage collection and repacking of @@ -68,7 +68,7 @@ a comparison with Git, including how workflows are different, see the * **Sparse checkouts: No.** However, there's native support for sparse checkouts. See the `jj sparse` command. * **Signed commits: Yes.** - You can sign commits automatically [by configuration](https://github.com/jj-vcs/jj/blob/main/docs/config.md#commit-signing), + You can sign commits automatically [by configuration](config.md#commit-signing), or use the `jj sign` command. * **Git LFS: No.** ([#80](https://github.com/jj-vcs/jj/issues/80)) diff --git a/docs/github.md b/docs/github.md index 96ffc186d..2ee968e8f 100644 --- a/docs/github.md +++ b/docs/github.md @@ -156,8 +156,7 @@ $ # force push $ jj git push --bookmark your-feature ``` -The hyphen after `your-feature` comes from the -[revset](https://github.com/jj-vcs/jj/blob/main/docs/revsets.md) syntax. +The hyphen after `your-feature` comes from the [revset](revsets.md) syntax. ## Working with other people's bookmarks