Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos: rework guide #527

Merged
merged 5 commits into from
May 8, 2024
Merged

nixos: rework guide #527

merged 5 commits into from
May 8, 2024

Conversation

soopyc
Copy link
Contributor

@soopyc soopyc commented May 6, 2024

This PR includes a near-complete rewrite of the NixOS guide. For illustrative purposes, pymdownx.tabbed and the linked tabs feature was added.

For context, the current NixOS guide is not exactly clear in some places, is outdated and contains code snippets which does not work on the current release. This PR aims to improve readability of the guide and update code snippets.

A deployment of the up-to-date render can be found here: https://t2wiki.soopy.moe

Tabbed helps illustrate various configuration methods in the NixOS installation guide.

Also removed a redundant item
docs/distributions/nixos/installation.md Outdated Show resolved Hide resolved
docs/distributions/nixos/installation.md Outdated Show resolved Hide resolved
docs/distributions/nixos/installation.md Outdated Show resolved Hide resolved
docs/distributions/nixos/installation.md Show resolved Hide resolved
docs/distributions/nixos/faq.md Outdated Show resolved Hide resolved
@soopyc soopyc marked this pull request as draft May 6, 2024 13:47
@soopyc
Copy link
Contributor Author

soopyc commented May 6, 2024

Most lint errors that could be fixed have been fixed. I could not figure out how to fix MD046/code-block-style without breaking content tabs.

@soopyc soopyc marked this pull request as ready for review May 6, 2024 14:30
@soopyc soopyc requested a review from AdityaGarg8 May 6, 2024 14:36
Copy link
Member

@AdityaGarg8 AdityaGarg8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A sample of the webpage would be needed to merge this. Probably use GitHub pages on your fork.

docs/distributions/nixos/installation.md Outdated Show resolved Hide resolved
@soopyc soopyc force-pushed the nixos branch 2 times, most recently from f61fa9c to d77f3c8 Compare May 6, 2024 15:19
soopyc added 2 commits May 6, 2024 23:24
Applying fixes to these 2 rules cause breakage to content tabs.
Disabling them locally so as to let other files be checked normally and still pass CI.
@soopyc
Copy link
Contributor Author

soopyc commented May 6, 2024

A sample of the webpage would be needed to merge this. Probably use GitHub pages on your fork.

A deployment of the forked wiki is available here with CF pages.

@AdityaGarg8
Copy link
Member

A sample of the webpage would be needed to merge this. Probably use GitHub pages on your fork.

A deployment of the forked wiki is available here with CF pages.

LGTM

@AdityaGarg8
Copy link
Member

Cc @Redecorating @networkException

@sharpenedblade
Copy link
Contributor

LGTM

Copy link
Member

@Redecorating Redecorating left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

been a while since i've used nix but this seems good.

docs/distributions/nixos/installation.md Show resolved Hide resolved
@AdityaGarg8 AdityaGarg8 merged commit f30c3bc into t2linux:master May 8, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants