Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

demos: update README demos #4237

Merged
merged 6 commits into from
Sep 6, 2024
Merged

demos: update README demos #4237

merged 6 commits into from
Sep 6, 2024

Conversation

ilyagr
Copy link
Collaborator

@ilyagr ilyagr commented Aug 8, 2024

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 write jj log -r 'all()'. So, one of the demos became a lot longer.

Fixes #3209

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • I have updated the config schema (cli/src/config-schema.json)
  • I have added tests to cover my changes

@ilyagr ilyagr changed the title demos: update demos demos: update README demos Aug 8, 2024
@ilyagr ilyagr force-pushed the demos branch 15 times, most recently from dc703a3 to 3c12341 Compare August 8, 2024 06:27
@joyously
Copy link

joyously commented Aug 8, 2024

Explain immutable commits

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 ilyagr force-pushed the demos branch 2 times, most recently from 85ebffd to f666722 Compare September 5, 2024 02:58
@ilyagr ilyagr marked this pull request as ready for review September 5, 2024 03:01
@ilyagr
Copy link
Collaborator Author

ilyagr commented Sep 5, 2024

Explain immutable commits

Yay! Right before I read this, I was thinking of asking for that explanation.

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 jj log shows.

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 martinvonz#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
martinvonz#4239
@ilyagr
Copy link
Collaborator Author

ilyagr commented 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.

@ilyagr ilyagr merged commit 42dee7d into martinvonz:main Sep 6, 2024
18 checks passed
@ilyagr ilyagr deleted the demos branch September 6, 2024 00:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README refers to deprecated checkout
3 participants