Skip to content

Conversation

@NotAShelf
Copy link
Owner

This PR migrates our entire documentation framework to https://github.com/feel-co/ndg, the tool that we've created to document Nix/OS related projects. While less mature, ndg is a much more flexible utility that we can tweak and improve based on our needs rather than relying on a nixpkgs-constrained utility with the worst error handling I've ever seen.

The current changes rely on an indev version of ndg, which I plan to release shortly. There are a few leftover bugs that need to be fixed before this can be merged, so draft until those two issues are fixed. Until then we can focus on wording and work on making existing pages more approachable by the users.

Signed-off-by: NotAShelf <[email protected]>
Change-Id: I6a6a6964151352d958f0c64949769d98dd759bdc
Signed-off-by: NotAShelf <[email protected]>
Change-Id: I6a6a6964720fae8f3db129835efa5d5df956c3ef
Signed-off-by: NotAShelf <[email protected]>
Change-Id: I6a6a696417907923e7def794fb49c28adb953ea7
Signed-off-by: NotAShelf <[email protected]>
Change-Id: I6a6a6964afba43bdda6a2cbf037404ca3fa4f8c9
@NotAShelf NotAShelf changed the base branch from main to v0.8 September 26, 2025 16:12
github-actions bot pushed a commit that referenced this pull request Sep 26, 2025
@github-actions
Copy link

github-actions bot commented Sep 26, 2025

🚀 Live preview deployed from ea3ee47

View it here:

Debug Information

Triggered by: NotAShelf

HEAD at: notashelf/push-ysqzsqxwlsml

Reruns: 1516

Signed-off-by: NotAShelf <[email protected]>
Change-Id: I6a6a6964ab066fe88fe52b53b619971a27f23a5b
github-actions bot pushed a commit that referenced this pull request Sep 26, 2025
@sjcobb2022 sjcobb2022 mentioned this pull request Sep 29, 2025
3 tasks
Signed-off-by: NotAShelf <[email protected]>
Change-Id: I6a6a69649ea7dd5c40657b8b8a30324b5f710ca9
@NotAShelf NotAShelf force-pushed the notashelf/push-ysqzsqxwlsml branch from 4ffa623 to 7bcb35f Compare October 7, 2025 06:39
github-actions bot pushed a commit that referenced this pull request Oct 7, 2025
Copy link
Collaborator

@horriblename horriblename left a comment

Choose a reason for hiding this comment

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

color contrast between text and background is too low for callout blocks and the options page.

some optional/future improvements:

  • the buttons in the "Contents" sidebar have 0 padding on the left when hovered over, looks kinda weird
  • release notes should probably be ordered newest->oldest
  • debounce on options search bar, my browser was choking hard on that

overall looks amazing, thanks :)

Signed-off-by: NotAShelf <[email protected]>
Change-Id: I6a6a6964075af959c6e20f0eb9772e17922b2531
@NotAShelf NotAShelf marked this pull request as ready for review October 18, 2025 10:04
@NotAShelf NotAShelf requested a review from Soliprem as a code owner October 18, 2025 10:04
github-actions bot pushed a commit that referenced this pull request Oct 18, 2025
@NotAShelf NotAShelf force-pushed the notashelf/push-ysqzsqxwlsml branch from dfd278d to 6102fc3 Compare October 18, 2025 10:07
Change-Id: I6a6a6964037deee07a8339f23493bc9e02905a37

Signed-off-by: NotAShelf <[email protected]>
Change-Id: I6a6a6964037deee07a8339f23493bc9e02905a37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants