joshuadanpeterson / typewriter.nvim

A Neovim plugin that emulates a typewriter, keeping the cursor centered on the screen for a focused writing experience.
MIT License
23 stars 0 forks source link

Fix Documentation Issue: Add and Update Help Files #10

Closed joshuadanpeterson closed 1 month ago

joshuadanpeterson commented 1 month ago

Description

This PR addresses Issue #7 where users encountered an error E429: File "/home/rasmus/.local/share/nvim/lazy/typewriter/doc/typewriter.txt" does not exist when trying to run :help typewriter. The following changes have been made to resolve this issue:

  1. Add Top-Level Tag to Help File:

    • Included a top-level tag *typewriter* in the typewriter.txt file to enable :help typewriter command in Neovim.
  2. Update Documentation:

    • Updated typewriter.txt with structured sections for description, features, changelog, and TODO.
    • Added recent changes to the changelog section:
      • v0.4.120 (2024-07-18)
        • feat(docs): Update CHANGELOG and TODO in help docs
        • docs: update CHANGELOG.md for v0.4.19 and remove duplicate entries
      • v0.4.19 (2024-07-18)
        • feat(docs): Add top-level tag to typewriter help file
        • docs: update CHANGELOG.md for v0.4.18 and remove duplicate entries
      • v0.4.18 (2024-07-07)
        • Merge pull request #6 from joshuadanpeterson/dev
        • docs: update CHANGELOG.md for v0.4.17 and remove duplicate entries
  3. Fix Documentation Issues:

    • Resolved issues with missing or incorrect documentation rendering by ensuring the help file is properly formatted and placed in the correct directory.
    • Remove .txt from .gitignore so typewriter.txt uploads to GitHub

Changes

How to Test If :help typewriter isn't working

  1. Place the typewriter.txt file in the doc directory of your Neovim runtime path.
  2. Run :helptags /path/to/typewriter/doc to regenerate the help tags.
  3. Test the :help typewriter command to verify that the documentation is accessible.

Related Issues