Commit graph

170 commits

Author SHA1 Message Date
Steve Klabnik
5b3aa51140 docs: jj-vcs.github.io -> jj-vcs.dev
As a follow-up to #8115, this moves all references in the codebase to use the new website.

I didn't update the older CHANGELOG entries because I figured they're intended
to be immutable.
2025-11-26 00:36:39 +00:00
Martin von Zweigbergk
7f28aad17d docs: fix some typos
Most of these were noticed by @omahs (thanks). I also fixed another
instance of "the the".
2025-11-25 20:27:59 +00:00
Martin von Zweigbergk
b409aa3189 colocation: rename from "colocated repo" to "colocated workspace"
Colocation is about sharing the working copy between jj and git. It's
less important where the repo is stored. I therefore think we should
not call it "colocated repo". I considered renaming it to "colocated
working copy" but that sounded awkward in many places because we often
talk about the whole workspace (repo + working copy), so "In colocated
workspaces with a very large number of branches or other refs" sounds
better than "In colocated working copies with a very large number of
branches or other refs".

Once we support colocate workspaces in non-main Git worktrees, I think
this rename will be even more relevant because then all those
workspaces share the same repo but only some of them may be colocated.
2025-11-03 16:53:26 +00:00
Ilya Grigoriev
93368f114f codespell: forbid British English
Some checks are pending
binaries / Build binary artifacts (push) Waiting to run
website / prerelease-docs-build-deploy (ubuntu-24.04) (push) Waiting to run
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
As suggested by @PhilipMetzger

The word "grey" is whitelisted because
- we have a contributor of that name
- we use a library that uses "Grey" as a member of an enum
- I refuse to believe "grey" is not US English
2025-09-07 15:51:44 +00:00
Benjamin Tan
b70a12e2db docs: standardize usage of term "colocate" without the hyphen
Some checks are pending
binaries / Build binary artifacts (push) Waiting to run
website / prerelease-docs-build-deploy (ubuntu-24.04) (push) Waiting to run
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
The hyphen-less version is preferred since there are already existing
command flags and config options which use the hyphen-less variation.
2025-09-05 16:32:25 +00:00
Remo Senekowitsch
12b3a26f3d undo: revert progressively older operations with repeated calls
New users (especially ones unfamiliar with CLI programs) intuitively
expect `jj undo` to work the same way the "undo" functionality of
typical GUI applications do. That means, running `jj undo` multiple
times should restore progressively older states of the repository
one-by-one.

Related feature request "jj undo ergonomics":
https://github.com/jj-vcs/jj/issues/3700
2025-08-24 06:56:40 +00:00
Martin von Zweigbergk
67ac9dc30d readme: the name of the binary will probably not change
I think it's very unlikely at this point that we'll rename the binary
from `jj` to something else, so let's not say that we might.
2025-07-20 20:40:20 +00:00
Emily
7bcc5cca8f git: remove git2 feature 2025-05-07 19:29:20 +00:00
Martin von Zweigbergk
be0ad55309 doc: update some references to "the native backend" 2025-03-21 16:27:51 +00:00
Lucas Garron
4e22902249 Replace the PNG logo with a vector SVG version.
This version is significantly smaller and crisp at any resolution.

Update docs/index.md
2025-03-11 22:44:13 +00:00
Aleksey Kuznetsov
cfcd034879 docs: Add pointers to usage of jj help -k <keyword>
Relates to #5306
2025-02-28 06:52:52 +00:00
Ilya Grigoriev
1d95bd6b55 docs and readme: add the new jj logo
It's half-sized (432x432 instead of 864x864) for size and
compressed with `pngquant` (difference not visible with
my eyes).
2025-02-07 20:40:23 +00:00
Keane Nguyen
7402362c80 README: replace outdated claim about lacking git blame support 2024-12-29 20:47:54 +01:00
Philip Metzger
2f14ad25a7 docs: Update the News section of the README
It has seriously gone out of date, so update it for 2025 and mention the new `jj-vcs` org.
The suggestion came from melutovich in the #jujutsu Libera IRC chat.
2024-12-27 20:29:22 +01:00
Anton Älgmyr
85adde923a Add links to release and license badges 2024-12-20 02:07:07 +01:00
Martin von Zweigbergk
b836e0ae95 docs/cli: update URLs to from martinvonz user to jj-vcs org
We just migrated to the jj-vcs GitHub org, so we should point to the
new GitHub URLs.
2024-12-17 12:44:44 -08:00
Ilya Grigoriev
694e20d255 README: Add libera IRC badge 2024-11-17 13:36:49 -08:00
Ilya Grigoriev
9d31e74992 README: add Contributing bullet
People will often look for contributing instructions from
https://github.com/martinvonz/jj, this makes it easier
to find.

It will also lead more people to read the contributing
docs on the website as opposed to GitHub. This is becoming
desireable, see the discussion at
https://github.com/martinvonz/jj/pull/4822#discussion_r1844611306
2024-11-15 20:30:12 -08:00
Ilya Grigoriev
7f971df3cd README: Remove the "build passing" badge
It feels extraneous. People can just look at whether the GitHub UI shows a checkmark
next to the commit.
2024-11-15 19:18:35 -08:00
Lukas Wirth
1410f2bee7 docs: Remove trailing whitespace in markdown files 2024-09-13 13:06:28 +02:00
Martin von Zweigbergk
1aa2aec141 bookmarks: update some leftover uses of the word "branch" 2024-09-11 19:19:31 -07:00
Ilya Grigoriev
51c374e917 demo git_compat and README: repurpose the demo somewhat
It is important to mention tracking branches and listing branches. This topic is important now that `jj log` does not show branches
`jj git clone` says it fetched by default. 

The demo has become more about navigating a Git remote, so I reworded
the README accordingly, shifting the focus more to "Git remote
compatibility" and away from "We include a Git repo". Both are
important, but these skills seem important for beginners.
2024-09-05 17:33:46 -07:00
Ilya Grigoriev
12fb514736 README: mention gitoxide in addition to libgit2
This seemed worth doing while I was working on the following commit. I
also moved the sentence for the purposes of the following commit.
2024-09-05 17:33:46 -07:00
Ilya Grigoriev
24c263698b readme: rename Roadmap to Development Roadmap
It seems a bit clearer to me.
2024-09-04 20:05:52 -07:00
Martin von Zweigbergk
250a28b5a5 docs: add a roadmap 2024-09-03 21:42:29 -07:00
Benjamin Tan
f76d682bab readme: include link to wiki "Media" page and fix broken changelog link 2024-07-10 18:09:38 +08:00
Martin von Zweigbergk
0525dc9d86 politics: delete references to Pijul
The Pijul maintainer has opinions that I don't understand about how we
mention Pijul (they consider the current mentions offensive as
"bashing Pijul"). Let's just remove the references so we don't have to
deal with it. I think the references to Darcs we already had in most
of these places are sufficient.
2024-04-14 13:16:08 -07:00
Steve Klabnik
e699e9da93 Fix link to my tutorial
2d62f22de1 reorganized some things, and so this link became broken
2024-03-20 14:56:28 -05:00
Chris Krycho
1ec6a8f92d Add @chriskrycho's YouTube series to the README 2024-03-19 10:42:14 -06:00
Martin von Zweigbergk
e9655dba13 move: deprecate the command
Per discussion in
https://github.com/martinvonz/jj/discussions/2882. `jj squash` now has
all the functionality.
2024-03-11 09:25:17 -07:00
Philip Metzger
e9fc8d4e40 Readme: Add a related media section and tidy up the news a bit.
This bundles all Jujutsu related media (the talk, its slides and the three articles we were featured in) 
into a section.

Also update the news section to mention the recent deprecations and the three articles we recently 
were featured in. 

Thanks to everyone who wrote one.
2024-02-15 20:04:37 +01:00
Austin Seipp
91d1205d55 readme: fix [!WARNING] section
Apparently this previously-beta markdown syntax from GitHub "graduated" to a
full feature in such a way that it it actually regressed in features, so doing
this `[!WARNING]` inline inside of a list is no longer valid. Sigh. Scoot it
up a level in the document, and just make it part of the section and not inside
the list.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
2024-02-08 16:59:55 -06:00
Ikko Eltociear Ashimine
96efc1224f docs: update README.md
minor fix.
2024-02-04 10:12:48 -06:00
Austin Seipp
889f052dfa readme: do some cleanup
As noted by Martin and Waleed on Discord.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I9cba734774a7e89dfd65c8202e76c2f4
2023-12-21 16:26:17 -06:00
Ilya Grigoriev
07fda2cec1 README: Fix a typo (extraneous word) 2023-11-23 13:57:37 -08:00
mlcui
7269365a0d readme: Add Discord badge to the top of document
A coworker was having trouble finding a link to the jj Discord community. Add it to the top of the document, alongside the other badges, so it's easier to find.
2023-11-14 10:22:22 +11:00
Austin Seipp
56ba801478 readme: improved frontmatter, part 2
Summary: What was going to just be some minor touch-ups to the existing content
ended in another rework of the frontmatter, this time primarily the sales pitch
and basic feature explanation.

The motivation here is simple: you should not just encounter a three-word noun
that is a hyperlink to pages with 1,000 words actually explaining the three-word
noun itself is. It's jarring!

Instead, the frontmatter is longer, expanding on each major selling point and
similarity to other tools. It actually *describes* the important, distinct
design decisions that tell you what the tool is and does, rather than just link
you around a bunch.

For example, one immediate thing is that calling jj a "DVCS" is actually kind
of odd when it later becomes apparent that you can have multiple data model and
commit backends; Google for example uses it in a more centralized manner than
others would via Piper/CitC. Calling it a "DVCS" is a bit strange in this sense
when *really* what we mean is that the Git data model allows independent copies
of the repo.

Overall I think this is *much* better for people who are just going to see the
README and may or may not bounce off immediately.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I9f0f78e56157ef434ec239710e00f3bd
2023-11-05 12:34:21 -06:00
Ilya Grigoriev
f81c724822 README.md: "quite" -> "fairly" feature complete
This makes a one-word change suggested in
1160641833

Thanks to @solson for the idea.
2023-10-08 21:29:04 -07:00
Austin Seipp
b66adb4bb7 readme: tidy up the front matter a little
Summary: Reintroduce 4acdf726 without spurious formatted changes. (This means I
don't have to go back over things with a fine comb.)

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I18ec68722362a2a64b99a368d3f25cf5
2023-10-07 16:35:06 -05:00
Austin Seipp
706c5026f6 backout of commit 4acdf72601 2023-10-07 16:35:06 -05:00
Austin Seipp
4acdf72601 readme: tidy up the front matter a little
Summary: Just a small rework of the very top-level frontmatter. Now:

- Uses `<div>` to center things a little
- Adds top-level links to the new homepage, installation guide, and tutorial
- Reworks the disclaimer and 'Introduction' section. After all, a README should
first say what the project is! I think this reads much better.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I2d92a21650afec0640add3741d4f20c5
2023-10-07 16:11:33 -05:00
Ilya Grigoriev
fd80dcd5ed README: Edits to Getting Started
The link to the glossary was weirdly far from the link to the FAQ.

Also, added a mention of the prerelease docs.
2023-09-11 18:22:56 -07:00
Ilya Grigoriev
eee3d488f1 README: point users to the new documentation website 2023-09-11 18:22:56 -07:00
Ilya Grigoriev
18bcc87794 docs: make co-located repos more prominent, more details
At this point, they are stable enough that I think we should
advertise them and encourage their use. This also explains
some caveats.
2023-09-06 09:15:27 -07:00
Ilya Grigoriev
64140c34b7 docs: Move installation instructions from README to docs/
This allows the tutorial to reference them and will make it
easier to have different instructions for different versions.

We can later restore some instructions to the README, but I
think this is important since the installation instructions
do change in important (even if slight) ways from time to
time.
2023-08-28 10:43:48 -07:00
Ben Saunders
e563d60e64 Update docs and errors to use XDG config path 2023-08-11 13:21:44 -07:00
Philip Metzger
8188dc42df Docs: Add a FAQ
This answers some questions, which were repeatedly asked in Discord.
2023-08-09 01:19:55 +02:00
Martin von Zweigbergk
d1b3a0a3e3 readme: fix typo (fix adopted from #1942) 2023-08-03 22:10:01 +00:00
Martin von Zweigbergk
b6c65c12ac readme: clarify that snapshotting doesn't result in a chain of commits
It's not clear at all right now that snapshotting the working copy
results in it being amended.
2023-08-02 21:13:46 +00:00
Martin von Zweigbergk
82be7f727c readme: format with IntelliJ
This makes it easier for me to make further changes. Hopefully it
won't make it harder for others.
2023-08-02 21:13:46 +00:00