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:
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.
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
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
Added and updated typewriter.txt in the doc directory.
Regenerated help tags to include the new documentation.
How to Test If :help typewriter isn't working
Place the typewriter.txt file in the doc directory of your Neovim runtime path.
Run :helptags /path/to/typewriter/doc to regenerate the help tags.
Test the :help typewriter command to verify that the documentation is accessible.
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:Add Top-Level Tag to Help File:
*typewriter*
in thetypewriter.txt
file to enable:help typewriter
command in Neovim.Update Documentation:
typewriter.txt
with structured sections for description, features, changelog, and TODO.Fix Documentation Issues:
Changes
typewriter.txt
in thedoc
directory.How to Test If
:help typewriter
isn't workingtypewriter.txt
file in thedoc
directory of your Neovim runtime path.:helptags /path/to/typewriter/doc
to regenerate the help tags.:help typewriter
command to verify that the documentation is accessible.Related Issues