Skip to content

Commit

Permalink
Fix typo in contributing guide (#641)
Browse files Browse the repository at this point in the history
  • Loading branch information
anotherhadi authored Jun 27, 2024
1 parent f0bc495 commit e170641
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ make test PLENARY=/path/to/your/plenary

## Building the Vim documentation

The Vim documentation lives at `docs/obsidian.txt`, which is automatically generated from the README using [panvimdoc](https://github.com/kdheepak/panvimdoc). **So please only commit documentation changes to the README, not `docs/obsidian.txt`.**
The Vim documentation lives at `doc/obsidian.txt`, which is automatically generated from the README using [panvimdoc](https://github.com/kdheepak/panvimdoc). **So please only commit documentation changes to the README, not `doc/obsidian.txt`.**

However you can test how changes to the README will affect the Vim doc by running panvimdoc locally.
To do this you'll need install `pandoc` (e.g. `brew install pandoc` on Mac) and clone [panvimdoc](https://github.com/kdheepak/panvimdoc). Then from the panvimdoc repo root, run:
Expand Down

0 comments on commit e170641

Please sign in to comment.