Skip to content

docs(README): nix nvf example - #5

Merged
sand4rt merged 2 commits into
mainfrom
docs-nix
Apr 12, 2026
Merged

sand4rt merged 2 commits into
mainfrom
docs-nix

Conversation

@sand4rt

@sand4rt sand4rt commented Apr 12, 2026

Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings April 12, 2026 17:00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the README usage section to present configuration examples in collapsible blocks, and adds a Nix NVF configuration example for installing/configuring zen.nvim.

Changes:

  • Wrap the Lazy.nvim usage instructions in a <details>/<summary> block.
  • Add a new <details> section with a Nix NVF example configuration.
  • Keep the rest of the README structure intact while expanding installation guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment on lines +25 to +26
<details>
<summary>Using [Lazy.nvim](https://github.com/folke/lazy.nvim)</summary>

Copilot AI Apr 12, 2026

Copy link

Choose a reason for hiding this comment

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

Markdown links inside HTML

tags typically aren’t rendered as links on GitHub (the text may display literally as [Lazy.nvim](...)). Consider using plain text in the summary, or switch to an HTML anchor (<a href=...>) to ensure the link works.

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Fix it @copilot

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Fixed in 241cdbe — replaced Markdown links in both <summary> tags with HTML <a> tags so they render correctly. Also pinned rev to "v1.0.0" for reproducibility.

Comment thread README.md Outdated
Comment on lines +69 to +72
<summary>Using [Nix NVF](https://github.com/NotAShelf/nvf)</summary>

```nix
programs.nvf.settings.vim.lazy.plugins = {

Copilot AI Apr 12, 2026

Copy link

Choose a reason for hiding this comment

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

The Nix NVF example is fenced as lua but the snippet is Nix code. Please change the code fence language to something like nix to avoid misleading syntax highlighting/copy-paste.

Copilot uses AI. Check for mistakes.
Comment thread README.md Outdated
src = pkgs.fetchFromGitHub {
owner = "sand4rt";
repo = "zen.nvim";
rev = "main";

Copilot AI Apr 12, 2026

Copy link

Choose a reason for hiding this comment

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

Using rev = "main" with fetchFromGitHub makes this example fragile: whenever the upstream main branch changes, the pinned hash will no longer match and builds will fail. Prefer pinning rev to a specific commit (and optionally updating version accordingly) so the example stays reproducible.

Suggested change
rev = "main";
rev = "v1.0.0";

Copilot uses AI. Check for mistakes.
Comment thread README.md Outdated
</details>

<details>
<summary>Using [Nix NVF](https://github.com/NotAShelf/nvf)</summary>

Copilot AI Apr 12, 2026

Copy link

Choose a reason for hiding this comment

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

Markdown links inside HTML

tags typically aren’t rendered as links on GitHub (the text may display literally as [Nix NVF](...)). Consider using plain text in the summary, or an HTML anchor (<a href=...>) so the link is clickable.

Suggested change
<summary>Using [Nix NVF](https://github.com/NotAShelf/nvf)</summary>
<summary>Using <a href="https://github.com/NotAShelf/nvf">Nix NVF</a></summary>

Copilot uses AI. Check for mistakes.
@sand4rt
sand4rt merged commit a4325a6 into main Apr 12, 2026
1 check passed
@sand4rt
sand4rt deleted the docs-nix branch April 12, 2026 17:14
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

Successfully merging this pull request may close these issues.

3 participants