Skip to content

doc: Render verbatim @docroot@ on contributing page#13221

Merged
edolstra merged 1 commit intoNixOS:masterfrom
roberth:doc-rl-docroot
May 17, 2025
Merged

doc: Render verbatim @docroot@ on contributing page#13221
edolstra merged 1 commit intoNixOS:masterfrom
roberth:doc-rl-docroot

Conversation

@roberth
Copy link
Member

@roberth roberth commented May 17, 2025

Motivation

Improve contributing docs. @docroot@ was substituted by mistake when talking about @docroot@.

In rendered form, this achieves the following change:

-Add references to the manual using ..
+Add references to the manual using [links like this](@docroot@/example.md)

Context


Add 👍 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

In rendered form:

```diff
-Add references to the manual using ..
+Add references to the manual using [links like this](@docroot@/example.md)
```
@roberth roberth requested a review from edolstra as a code owner May 17, 2025 15:52
@roberth roberth changed the title doc: Render verbatim @docroot@ on contributing page doc: Render verbatim @docroot@ on contributing page May 17, 2025
@edolstra edolstra added the backport 2.29-maintenance Automatically creates a PR against the branch label May 17, 2025
@edolstra edolstra merged commit e5e5c81 into NixOS:master May 17, 2025
13 checks passed
mergify bot added a commit that referenced this pull request May 17, 2025
…3221

doc: Render verbatim `@docroot@` on contributing page (backport #13221)
@roberth roberth added backports created Does not require attention and can be filtered away backport 2.28-maintenance Automatically creates a PR against the branch labels Jul 30, 2025
mergify bot added a commit that referenced this pull request Jul 30, 2025
…3221

doc: Render verbatim `@docroot@` on contributing page (backport #13221)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.28-maintenance Automatically creates a PR against the branch backport 2.29-maintenance Automatically creates a PR against the branch backports created Does not require attention and can be filtered away documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants