docs: add a README to the Nixfiles, improve formatting #11472
Merged
Conversation
This file contains 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
- there is already documentation for this, so just link to the existing docs
- just handy to have a back-link for those less familiar with Nix and who stumble upon it
- also improve some grammar and formatting in the Nix docs
- use code backticks for all commands
- use markdown convention of using `1.` for all items of an ordered list and having the renderer determine the numbering
- use the name of the doc (Running Locally) instead of "this"
- more consistent with the rest of the docs
- also merge 1 and 2 as they're both mentioned in Running Locally
- separate run-on sentence
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
|
cc @isubasinghe |
sarabala1979
approved these changes
Jul 29, 2023
|
@isubasinghe sorry I didn't realize Terry tagged you. Please review and comment it. |
|
I didn't change any Nixfiles or real content (mostly formatting/style), so thought it'd be ok for anyone to review. Otherwise would cc @isubasinghe myself who knows Nix better than I currently do |
|
LGTM since its just markdown |
agilgur5
added
type/dependencies
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.
Motivation
There is already documentation for this, so just link to the existing docs
CONTRIBUTING.mdat root of repo, directing todocs/#10969Modifications
add a README with a one-line link to
dev/nix/also improve some grammar and formatting in the Nix docs
1.for all items of an ordered list and having the renderer determine the numberingVerification
Double-checked that the relative link worked locally