Skip to content

Comments

docs: work around ndg bug where closing tip delimiter tag breaks things#1375

Closed
JamyGolden wants to merge 1 commit intoNotAShelf:mainfrom
JamyGolden:jamy/bugfix/ndg-closing-tip-delimiter
Closed

docs: work around ndg bug where closing tip delimiter tag breaks things#1375
JamyGolden wants to merge 1 commit intoNotAShelf:mainfrom
JamyGolden:jamy/bugfix/ndg-closing-tip-delimiter

Conversation

@JamyGolden
Copy link
Contributor

I looked into the bugs #1290 and #1327 and found the issue lay with ndg and I created an issue mentioning the problem: feel-co/ndg#106

This PR fixes the bugs mentioned in the issues above and is a work around the ndg bug

Sanity Checking

  • I have updated the changelog as per my changes
  • I have tested, and self-reviewed my code
  • My changes fit guidelines found in hacking nvf
  • Style and consistency
    • I ran Alejandra to format my code (nix fmt)
    • My code conforms to the editorconfig configuration of the project
    • My changes are consistent with the rest of the codebase
  • If new changes are particularly complex:
    • My code includes comments in particularly complex areas
    • I have added a section in the manual
    • (For breaking changes) I have included a migration guide
  • Package(s) built:
    • .#nix (default package)
    • .#maximal
    • .#docs-html (manual, must build)
    • .#docs-linkcheck (optional, please build if adding links)
  • Tested on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin

@NotAShelf
Copy link
Owner

NotAShelf commented Jan 30, 2026

As stated previously, this is not an actual fix; it'll be undid automagically when a formatter is ran, and the PR will become meaningless.

I appreciate the effort, however, this has to be fixed in NDG as it's a critical bug in the include pipeline and can only be fixed non-hackily by doing so.

Edit: I'll be looking into fixing this in NDG once my current NDG work is done; I've been busy with the 12 trillion projects that I've taken up for some reason, so it's taking some time.

@JamyGolden JamyGolden force-pushed the jamy/bugfix/ndg-closing-tip-delimiter branch from 03ebbe0 to 48fd16f Compare January 31, 2026 00:26
@JamyGolden JamyGolden closed this Jan 31, 2026
github-actions bot pushed a commit that referenced this pull request Jan 31, 2026
@github-actions
Copy link

🚀 Live preview deployed from fde1338

View it here:

Debug Information

Triggered by: JamyGolden

HEAD at: jamy/bugfix/ndg-closing-tip-delimiter

Reruns: 1995

@JamyGolden
Copy link
Contributor Author

Not sure where that was stated previously, the tickets I linked to in this PR don't mention that. There are other ways to fix this in nvf that don't include an empty line at the end of a file which formatters might remove, but fixing it directly in ndg is obviously the best way to do it.

Thanks for the effort you put into the open source community.

@JamyGolden JamyGolden deleted the jamy/bugfix/ndg-closing-tip-delimiter branch January 31, 2026 12:05
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