diff --git a/.gitignore b/.gitignore index 6034d7c36ccc..e22797d160eb 100644 --- a/.gitignore +++ b/.gitignore @@ -22,6 +22,7 @@ !CONTRIBUTING.md !COPYING.md !COPYRIGHT +!REQUEST.md !INSTALL.md !MANUAL.txt !Makefile diff --git a/REQUEST.md b/REQUEST.md new file mode 100644 index 000000000000..7b6eed5489d1 --- /dev/null +++ b/REQUEST.md @@ -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.