Skip to content

Update documentation path in README#2

Merged
trippwill merged 2 commits into
mainfrom
codex/update-output-path-in-readme.md-example
Jun 7, 2025
Merged

Update documentation path in README#2
trippwill merged 2 commits into
mainfrom
codex/update-output-path-in-readme.md-example

Conversation

@trippwill
Copy link
Copy Markdown
Owner

Summary

  • update doc generation example output path in README

Testing

  • sh test.sh (fails: nvim not found)

https://chatgpt.com/codex/tasks/task_e_68442bacbda8832e9389b21369669713

Copilot AI review requested due to automatic review settings June 7, 2025 12:21
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

A concise update to the README sample command for generating documentation to reflect the new output filename.

  • Updated the example doc.sh invocation to use doc/swapdiff.nvim.txt instead of doc/swapdiff.txt.
Comments suppressed due to low confidence (1)

README.md:139

  • The updated line is missing the list bullet marker (- ) for the nested list. Add - before Run to maintain consistent Markdown formatting.
Run `sh doc.sh doc/swapdiff.nvim.txt doclist` to generate Vim help docs using [vimcats](https://github.com/triptychlabs/vimcats).

@trippwill trippwill merged commit 15d5dcb into main Jun 7, 2025
1 check passed
@trippwill trippwill deleted the codex/update-output-path-in-readme.md-example branch June 7, 2025 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants