Hi There, I'm Nisamov.
I have taken some time to review your repository, and I noticed a few issues both in the README file and in the overall repository structure. I am currently working on a similar project, so I would like to share some constructive suggestions that you may find useful in order to improve the quality and maintainability of your repository.
1. Fix image paths in the README
It appears that the image paths in the README are not correctly implemented. I recommend using the following structure:
I strongly suggest storing all multimedia content inside the .github directory. This approach helps keep the repository clean and organized while also providing simple and consistent paths. Make sure to name your files clearly so they can be referenced easily later.
2. Automate processes using workflows
Avoid requiring users to manually download packages in order to perform tasks themselves. Instead, consider creating an automated workflow to handle these processes. This will significantly reduce manual effort and improve the user experience.
For example, you can configure a workflow to automatically generate EPUB or PDF files in just a few seconds, without requiring any additional setup from the user (be sure to test that the generated files can be downloaded correctly).
# Workflow directory path:
.github/workflows/example.yml
Within this file, you can define all the necessary logic to automate the process. If the workflow becomes too complex, you may also create a /scripts directory to support it with additional scripts.
These are just a few simple suggestions that I believe could greatly improve your repository. Keep up the good work, and best of luck with the project!
Hi There, I'm Nisamov.
I have taken some time to review your repository, and I noticed a few issues both in the README file and in the overall repository structure. I am currently working on a similar project, so I would like to share some constructive suggestions that you may find useful in order to improve the quality and maintainability of your repository.
1. Fix image paths in the README
It appears that the image paths in the README are not correctly implemented. I recommend using the following structure:
I strongly suggest storing all multimedia content inside the
.githubdirectory. This approach helps keep the repository clean and organized while also providing simple and consistent paths. Make sure to name your files clearly so they can be referenced easily later.2. Automate processes using workflows
Avoid requiring users to manually download packages in order to perform tasks themselves. Instead, consider creating an automated workflow to handle these processes. This will significantly reduce manual effort and improve the user experience.
For example, you can configure a workflow to automatically generate EPUB or PDF files in just a few seconds, without requiring any additional setup from the user (be sure to test that the generated files can be downloaded correctly).
# Workflow directory path: .github/workflows/example.ymlWithin this file, you can define all the necessary logic to automate the process. If the workflow becomes too complex, you may also create a
/scriptsdirectory to support it with additional scripts.These are just a few simple suggestions that I believe could greatly improve your repository. Keep up the good work, and best of luck with the project!