pdfly icon indicating copy to clipboard operation
pdfly copied to clipboard

Diagrams for all commands

Open d-mahi14 opened this issue 2 months ago โ€ข 8 comments

Fixes https://github.com/py-pdf/pdfly/issues/178

Checklist:

  • [ ] A unit test is covering the code added / modified by this PR

  • [ ] In case of a new feature, docstrings have been added, with also some documentation in the docs/ folder

  • [ ] A mention of the change is present in CHANGELOG.md

  • [ ] This PR is ready to be merged

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD 3-Clause license.

d-mahi14 avatar Oct 13 '25 18:10 d-mahi14

That is very nice!

What do you think about moving them into docs + adding the drawio source file so that others can easily make adjustments?

MartinThoma avatar Oct 13 '25 20:10 MartinThoma

Good job ๐Ÿ‘

What do you think about moving them into docs + adding the drawio source file so that others can easily make adjustments?

I fully agree with @MartinThoma ๐Ÿ™‚

Also, after that you should be able to insert a reference to the PNG images in the corresponding Markdown files for the subcommands.

Lucas-C avatar Oct 13 '25 21:10 Lucas-C

Okay so do i have to add diagrams of all commands or just 2-up command and booklet command @Lucas-C??

d-mahi14 avatar Oct 14 '25 02:10 d-mahi14

Okay so do i have to add diagrams of all commands or just 2-up command and booklet command @Lucas-C??

Given that you already made diagrams for all commands, you can insert an image in all subcommands Markdown pages where you created on ๐Ÿ™‚

Lucas-C avatar Oct 14 '25 05:10 Lucas-C

Hi @d-mahi14

I see you added a new commit to this PR, but I'm afraid my request was misunderstood:

  • no need to introduce a new docs/commands.md file, images should be inserted in the existing docs/user/subcommand*.md files
  • please don't insert images in Markdown files using a data: prefix. Use the standard syntax to embed images by referencing a file in the repository: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images

Out of curiosity, are you new to open source contributions and/or programming? I totally understand if you don't know much currently about Markdown / git / etc. I would be happy to help so please ask questions if need be ๐Ÿ™‚

Lucas-C avatar Oct 15 '25 06:10 Lucas-C

Yess am new to hacktoberfestโ€ฆI got the subcommand.md file will work on it now

On Wed, 15 Oct 2025 at 11:46โ€ฏAM, Lucas Cimon @.***> wrote:

Lucas-C left a comment (py-pdf/pdfly#186) https://github.com/py-pdf/pdfly/pull/186#issuecomment-3404714192

Hi @d-mahi14 https://github.com/d-mahi14

I see you added a new commit to this PR, but I'm afraid my request was misunderstood:

  • no need to introduce a new docs/commands.md file, images should be inserted in the existing docs/user/subcommand*.md files
  • please don't insert images in Markdown files using a data: prefix. Use the standard syntax to embed images by referencing a file in the repository: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images

Out of curiosity, are you new to open source contributions and/or programming? I totally understand if you don't know much currently about Markdown / git / etc. I would be happy to help so please ask questions if need be ๐Ÿ™‚

โ€” Reply to this email directly, view it on GitHub https://github.com/py-pdf/pdfly/pull/186#issuecomment-3404714192, or unsubscribe https://github.com/notifications/unsubscribe-auth/BPSCKHMU7GKZYGVZ5GN4F4D3XXRDZAVCNFSM6AAAAACJCE7GE6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTIMBUG4YTIMJZGI . You are receiving this because you were mentioned.Message ID: @.***>

d-mahi14 avatar Oct 15 '25 08:10 d-mahi14

please review it again @Lucas-C

d-mahi14 avatar Oct 15 '25 08:10 d-mahi14

Hi ๐Ÿ™‚ ๐Ÿ‘‹ We are close to the end of the month, I was just curious to know if you were willing to finish this PR as part of Hacktoberfest?

Lucas-C avatar Oct 27 '25 07:10 Lucas-C