WIP: docs: add a script that generates FEATURES.md #1371
Conversation
This script takes FEATURES.src.md and finds all ```pwndbg blocks. Then it executes them with pwngdb and creates an svg screenshot. It can also compile some basic C programs and adds some annotations to the screenshots.
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## dev #1371 +/- ##
=======================================
Coverage 59.26% 59.26%
=======================================
Files 174 174
Lines 20971 20971
Branches 1848 1848
=======================================
Hits 12429 12429
Misses 7945 7945
Partials 597 597 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
|
Ping 🙂 If there's more work to do here, we can always get what's currently implemented shipped and then come back to the remaining work later. |
|
Ping |
|
Hi, haven't had much time lately, but I still remember about this. If you fell like it clutters up the pull requests you can close it. I will send another one when it's ready. |
No worries, can you mark it as a draft PR for now? And again, whenever you get time to work on this we can merge any smaller bits of it that are done even if the whole thing isn't complete. |
This script takes FEATURES.src.md and finds all ```pwndbg blocks.
Then it executes them with pwngdb and creates an svg screenshot.
It can also compile some basic C programs and adds some annotations to the screenshots.
You can see the generated file here: https://github.com/alufers/pwndbg/blob/docs/new-features-docs/docs/FEATURES.md
I will add some more docs with examples to this file.