docs: link to standard.md in README #361
Open
Conversation
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
jfly
reviewed
Dec 17, 2025
README.md
Outdated
|
|
||
| Nixfmt is the official formatter for Nix language code. | ||
| The standard Nix format is defined in [standard.md](./standard.md). | ||
| It is maintained by the [Nix formatting team](https://nixos.org/community/teams/formatting/). |
Collaborator
There was a problem hiding this comment.
"It" now refers to something different. Can we put the new sentence somewhere else?
Member
Author
There was a problem hiding this comment.
"It" now refers to something different.
Good catch.
Can we put the new sentence somewhere else?
Given the current README structure, I believe this is the best place. What about replacing "It" with "Nixfmt":
diff --git a/README.md b/README.md
index 4875d0d..450bdb7 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,8 @@
# Nixfmt
Nixfmt is the official formatter for Nix language code.
-It is maintained by the [Nix formatting team](https://nixos.org/community/teams/formatting/).
+The standard Nix format is defined in [standard.md](./standard.md).
+Nixfmt is maintained by the [Nix formatting team](https://nixos.org/community/teams/formatting/).
This document is the user documentation, see [CONTRIBUTING.md](./CONTRIBUTING.md) for contributor documentation.
## Installation
Member
Author
|
Converting this to draft until #304 (comment) has been resolved. CC: @MattSturgeon |
trueNAHO
force-pushed
the
docs-link-to-standard-md-in-readme
branch
from
e303e43 to
8731330
Compare
Member
Author
I am interpreting the 👍 on #304 (comment) and #361 (comment) as an approval. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
CC: @jfly