payloadsallthethings: 3.0 -> 4.2 (2025.1), render using mkdocs #431002
Conversation
5e322da to
a3751d8
Compare
There was a problem hiding this comment.
Hi @felbinger , thanks for the update/changes, good idea!
Everything LGTM! Builds as expected.
One minor trade-off I see is that users won't be able to choose a different theme for building the docs unless they explicitly override the package. That said, I do think that the practical benefits outweigh the tradeoffs here.
|
|
@felbinger Another note: seems like the releases on the github are now more consistent, the original reason I have used the latest commit hash instead of versioning was because the latest edition dated from several years.. Actually, I'm just wondering if we should keep building with the latest commit? I only see upsides by doing so tbh. I'm not sure if they will be consistent enough with releases in the future. What do you think? |
The advantage of using a tag would be automatic update by the bot, right? I'm not quiet sure if this would work with the latest hash too... |
|
I just had another idea: how about this, to allow the user to choose from just the markdown sources (out) of the rendered html files (doc)? |
You're right.. Let's keep the tag then 👍 |
Yes that's perfect! |
I just asked someone with more experience, if it's okay to use this output for it, if yes I will squash the commits. |
| stdenvNoCC.mkDerivation { | ||
| pname = "payloadsallthethings"; | ||
| version = "3.0-unstable-2024-01-21"; | ||
| version = "2025.1"; |
There was a problem hiding this comment.
Why do we have two version numbers?
There was a problem hiding this comment.
don't know. I think 2025.1 is the better fit, we need the 4.2 for the tag
There was a problem hiding this comment.
No idea, we'll leave it like this until someone has a better idea 😅
63ff1ff to
69cc690
Compare
69cc690 to
dfa3804
Compare
Hey @shard77. I was thinking: Maybe we should render the files directly into HTML using MkDocs.
That way, they can be served directly by a web server, or accessed locally using something like
python2.7 -m SimpleHttpServer,python3 -m http.server,php -S localhost:8080, or any other local webserver.Also I updated to the latest version (4.2 aka. 2025.1)
Things done
passthru.tests.nixpkgs-reviewon this PR. See nixpkgs-review usage../result/bin/.Add a 👍 reaction to pull requests you find important.