demos: update README demos #4237
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ilyagr
force-pushed
the
demos
branch
15 times, most recently
from
dc703a3 to
3c12341
Compare
Yay! Right before I read this, I was thinking of asking for that explanation. |
Aside: thanks to ChatGPT for helping fix the error from argument order.
ilyagr
force-pushed
the
demos
branch
2 times, most recently
from
85ebffd to
f666722
Compare
Unfortunately, I didn't figure out a way to include immutable commits, but maybe we figure out one later. Still, I updated one of the demos significantly to talk about what |
This updates demos to the point where they can run without warnings. Some of them become less clear, this is addressed (where I noticed it) in follow-up commits. Fixes jj-vcs#3209
This seemed worth doing while I was working on the following commit. I also moved the sentence for the purposes of the following commit.
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.
I would prefer to shorten it instead of fully redacting, but I ran into jj-vcs#4239
martinvonz
approved these changes
Sep 5, 2024
|
Thanks for the review! I'll wait a bit in case anybody else wants to have a look, will probably merge it tomorrow. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here is the rendered README with these changes.
I initially meant to only do minimal changes, but I think we have to discuss tracked branches now that they affect the output of
jj log, at least so that people know to writejj log -r 'all()'. So, one of the demos became a lot longer.Fixes #3209
Checklist
If applicable:
CHANGELOG.md