-
-
Notifications
You must be signed in to change notification settings - Fork 308
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
docs/search: refactor to use override
#2536
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good from my house.
@mergify queue |
✅ The pull request has been merged automaticallyThe pull request has been merged automatically at cdbda98 |
This pull request, with head sha This pull request will be automatically closed by GitHub.As soon as GitHub detects that the sha 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 |
search = mkSearch "/"; | ||
search = nuschtosSearch.packages.mkSearch { | ||
optionsJSON = options-json + "/share/doc/nixos/options.json"; | ||
urlPrefix = "https://github.com/nix-community/nixvim/tree/main"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should maybe the github URL overrideable too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if that is best done by CI, or by having a version.json
file? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say doing it in the CI workflow, as we already have an override. I don't think we expect to build the stable docs outside CI
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm more thinking of end-users who may wish to build the docs locally themselves.
Or if we want to locally build them to test out a backport or whatever.
But sure, it's not too important to get perfect straight away
This should hopefully make branching off 24.11 easier, and may also be a step towards having additional docs versions available and/or docs linking to each other.