Skip to content

docs/server: refactor & improve serve-docs; add nix run .#docs #3349

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

Merged
merged 4 commits into from
May 22, 2025

Conversation

MattSturgeon
Copy link
Member

@MattSturgeon MattSturgeon commented May 21, 2025

Refactor serve-docs using makeWrapper, make it available as a serve-docs package and as the docs "app".

This means nix build .#docs will build the docs while nix run .#docs will run the server.

Also: automatically open the browser using xdg-open.

Related to nix-community/stylix#1328.

Copy link
Member

@GaetanLepage GaetanLepage left a comment

Choose a reason for hiding this comment

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

Very nice!

Refactor `serve-docs` using `makeWrapper`, make it available as a
`serve-docs` package and as the `docs` "app".

This means `nix build .#docs` will build the docs while `nix run .#docs`
will run the server.
@MattSturgeon

This comment was marked as resolved.

This comment was marked as resolved.

Copy link
Contributor

mergify bot commented May 22, 2025

This pull request, with head sha e385bec735ea03d2e009cde443cf77f3d0aea40e, has been successfully merged with fast-forward by Mergify.

This pull request will be automatically closed by GitHub.

As soon as GitHub detects that the sha e385bec735ea03d2e009cde443cf77f3d0aea40e is part of the main branch, it will mark this pull request as merged.

It is possible for this pull request to remain open if this detection does not happen, this usually happens when a force-push is done on this branch docs/server, this means GitHub will fail to detect the merge.

@mergify mergify bot merged commit e385bec into nix-community:main May 22, 2025
4 checks passed
@mergify mergify bot temporarily deployed to github-pages May 22, 2025 13:12 Inactive
@MattSturgeon MattSturgeon deleted the docs/server branch May 22, 2025 13:12
MattSturgeon added a commit to MattSturgeon/nixvim that referenced this pull request May 23, 2025
This fixes a regression introduced by nix-community#3349
MattSturgeon added a commit to MattSturgeon/nixvim that referenced this pull request May 23, 2025
This fixes a regression introduced by nix-community#3349
mergify bot pushed a commit that referenced this pull request May 23, 2025
This fixes a regression introduced by #3349

(cherry picked from commit e3f4a57)
mergify bot pushed a commit that referenced this pull request May 23, 2025
This fixes a regression introduced by #3349

(cherry picked from commit e3f4a57)
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.

2 participants