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

docs: add tutorial on how to use :builtin diff editor #3599

Merged
merged 1 commit into from
May 3, 2024

Conversation

Cretezy
Copy link
Contributor

@Cretezy Cretezy commented Apr 30, 2024

The built-in diff editor (https://github.com/arxanas/scm-record#scm-diff-editor) is confusing to use for new users. The tutorial should teach the basic usage of the tool and suggest another tool directly.

Related: arxanas/scm-record#25

Checklist

If applicable:

  • I have updated the documentation (README.md, docs/, demos/)

Copy link
Member

@martinvonz martinvonz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arxanas seems like the best person to review this.

docs/tutorial.md Outdated Show resolved Hide resolved
Copy link
Contributor

@arxanas arxanas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Add something about clicking the menu bar items to explore the available operations, since it never so much as occurs to many people to click them?

docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
@Cretezy Cretezy force-pushed the push-tzkqstplyytv branch from 183aac9 to 2da1c7c Compare May 1, 2024 01:05
@Cretezy Cretezy force-pushed the push-tzkqstplyytv branch from 2da1c7c to 0e4cc2d Compare May 3, 2024 02:52
@Cretezy Cretezy merged commit d9d6011 into jj-vcs:main May 3, 2024
16 checks passed
@Cretezy Cretezy deleted the push-tzkqstplyytv branch May 3, 2024 03:04
ilyagr added a commit to ilyagr/jj that referenced this pull request May 5, 2024
Follows up on jj-vcs#3599. I also moved the discussion of other diff editors to a
footnote, as it didn't seem to fit well into the flow of the text.
ilyagr added a commit to ilyagr/jj that referenced this pull request May 5, 2024
Follows up on jj-vcs#3599. I also moved the discussion of other diff editors to a
footnote, as it didn't seem to fit well into the flow of the text.
ilyagr added a commit that referenced this pull request May 6, 2024
Follows up on #3599. I also moved the discussion of other diff editors to a
footnote, as it didn't seem to fit well into the flow of the text.
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.

3 participants