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

Clarify Lesson 1.6 instructions about 'nvim tutor' file editing #1345

Open
pythoncarpenter opened this issue Feb 6, 2025 · 0 comments
Open

Comments

@pythoncarpenter
Copy link

Summary

In the included Neovim Tutor (Lesson 1.6: EDITING A FILE), the user is instructed to run `nvim tutor` from a second terminal.
This is confusing for users who expect an integrated sub-lesson (or a dedicated practice file) inside kickstart.nvim’s tutorial flow.
It isn’t obvious that they’re just editing a blank “tutor” file with no automated “check” or linking back to the main tutorial.

Details

  • What happens: Lesson 1.6 says:

    If can access to another terminal, do the following there:
    $ nvim tutor

    Then `:wq` to save. But there is no actual sub-lesson in that file, nor an automatic check that the user completed the practice.

  • What we expected:

    1. Possibly a specific practice file that is recognized by the tutorial, e.g. “kickstart_lesson_1_6.txt.”
    2. When the user returns to the Tutor, a checkmark or some feedback that Lesson 1.6 is “done.”
    3. Clear instructions on how to link the user’s edits back to the main lesson flow.

Why It Matters

  • Newcomers see `nvim tutor` and assume it’s an official sub-lesson integrated with the main tutorial, but it’s just a generic “tutor” file name.
  • Because there is no auto-check for completion, users wonder if they did everything correctly or if the tutorial should reflect “Lesson 1.6 complete.”

Proposed Solutions

  • Update the text in Lesson 1.6 to clarify:

    "Open a second terminal and run `nvim some_practice_file`. Once you edit and save, come back to the Tutor. (Note: there’s no auto-check; just practice the commands.)"

  • Optionally: Provide a short dummy file (e.g., `.local/share/nvim/kickstart_lesson_1_6.txt`) which the user can edit so that the main Tutor sees changes (if you plan to implement any form of “completion” check).
  • Or simply rename the file name in instructions from “tutor” to something less confusing like “mypractice.txt.”

Thanks for all your work on kickstart.nvim—really helpful for new Neovim users!

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

No branches or pull requests

1 participant