Skip to content

help needed understanding documentation #11661

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.

Sign up for GitHub

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

Closed
MuhammadAttiqueUrRehman207 wants to merge 1 commit into from
+17 −0
Closed

help needed understanding documentation #11661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
!CONTRIBUTING.md
!COPYING.md
!COPYRIGHT
!REQUEST.md
!INSTALL.md
!MANUAL.txt
!Makefile
Expand Down
16 changes: 16 additions & 0 deletions REQUEST.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Hi John,

Thank you for your earlier feedback regarding the architectural proposal and the maintainability concerns.

I am currently exploring the Pandoc codebase and documentation in more detail while working on issue #11626 related to EPUB → PDF conversion using the Typst engine. During this process, I realized that understanding the interactions between readers, writers, AST transformations, and format-specific processing can be quite challenging for new contributors.

As you previously mentioned, better documentation may help address some of these maintainability and onboarding difficulties. I would appreciate any guidance regarding:

* Important architectural documentation sections
* Recommended starting points for understanding the conversion pipeline
* Key modules involved in reader/writer interactions
* Existing contributor resources that may help with debugging and architectural understanding

I am continuing the investigation locally and plan to open a PR once the issue analysis and implementation are completed. Any suggestions or references would be very helpful for improving understanding of the system architecture and development workflow.

Thank you again for your guidance and feedback.