Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the README.md documentation by fixing grammatical errors, clarifying language, and correcting formatting issues throughout the document. The changes enhance readability and consistency while maintaining the same technical content and structure.
Key changes include:
- Grammar and clarity improvements in explanations and descriptions
- Corrected punctuation and sentence structure
- Fixed a malformed HTML tag and duplicate text
| <p align="right"> | ||
| <a href="https://nixos.org/"> <img src="https://img.shields.io/badge/Nix-Flake-informational?logo=nixos&logoColor=white" alt="Nix Flake"/> </a> | ||
| <a href="https://github.com/vic/flake-file/actions"> <img src="https://github.com/vic/flake-file/workflows/flake-check/badge.svg" alt="CI Status"/> </a> | ||
| <img src="https://github.com/vic/flake-file/workflows/flake-check/badge.svg" alt="CI Status"/> </a> |
There was a problem hiding this comment.
The HTML structure is malformed. There's an opening tag followed by a closing tag without a corresponding opening tag. Either restore the tag or remove the closing tag.
Suggested change
| <img src="https://github.com/vic/flake-file/workflows/flake-check/badge.svg" alt="CI Status"/> </a> | |
| <a href="https://github.com/vic/flake-file/actions"> <img src="https://github.com/vic/flake-file/workflows/flake-check/badge.svg" alt="CI Status"/> </a> |
| - Syntax for nixConfig and follows is the same as in flakes. | ||
| - `flake check` ensures files are up to date. | ||
| - App for generator: `nix run .#write-flake` | ||
| - App for generator: `nix run .#write-flake`#write-flake` |
There was a problem hiding this comment.
There's duplicated text in the inline code. The line contains #write-flake twice. It should be: - App for generator: \nix run .#write-flake``
Suggested change
| - App for generator: `nix run .#write-flake`#write-flake` | |
| - App for generator: `nix run .#write-flake` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.