doc,nixos/doc: minor cleanups #207150
Merged
doc,nixos/doc: minor cleanups #207150
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
jtojnar
reviewed
Dec 22, 2022
| @@ -199,7 +199,7 @@ It’s important to test any executables generated by a build when you change or | |||
|
|
|||
| ### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards} | |||
|
|
|||
| The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc\... Everyone should read and understand the standards the community has for contributing before submitting a pull request. | |||
| The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc... Everyone should read and understand the standards the community has for contributing before submitting a pull request. | |||
There was a problem hiding this comment.
Perhaps we could use real ellipsis in the Markdown.
There was a problem hiding this comment.
As long as smart is enabled, it doesn't matter. I think disabling smart would make sense though. But then there's the problem of uniformity: there's no way we're going to enforce consistent use of … across the manuals.
People do not want NixOS systems to depend on pandoc/GHC. |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-42/24204/1 |
Leftovers from the CommonMark conversion.
Leftovers from the CommonMark conversion.
Leftovers from the CommonMark conversion.
Update the pinned channel in `md-to-db`, which bumps the Pandoc version, which fixes NixOS#125511 maybe.
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.
it'sin the original DocBook would have been converted toit\'sin CommonMark to avoid triggering the "smart" typography mode that would turn it intoit’s. Whether we want actually smart quotes or not in the manual is another question.Those were done with a bulk
sed -iand then manually inspected to avoid breaking code snippets.md-to-dbshebang, which bumps Pandoc, which fixes Markdown to Docbook pandoc conversion loses information about language in fenced code block #125511, except it doesn't actually change anything because the DocBook → HTML conversion also loses information...By the way, why aren't we calling
md-to-dbautomatically in the derivation? Committing generated files seems like a bad idea, and this would avoid the concerns of #168598. EDIT: found some backlog: #63513 #106847 (comment) #175586 (comment)