Skip to content
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.

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

Write better documentation #5

Open
1 of 19 tasks
thedrummeraki opened this issue Sep 23, 2021 · 5 comments
Open
1 of 19 tasks

Write better documentation #5

thedrummeraki opened this issue Sep 23, 2021 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@thedrummeraki
Copy link
Owner

All of the documentation will be living here. As of today, it is incomplete.

Below is a list of PRs that are responsible for documenting each aspect of the codebase

  • Mangadex::Api
  • Mangadex::Internal
  • Mangadex::Artist
  • Mangadex::Auth
  • Mangadex::Author
  • Mangadex::Chapter
  • Mangadex::ContentRating
  • Mangadex::CoverArt
  • Mangadex::CustomList
  • Mangadex::Manga
  • Mangadex::Relationship
  • Mangadex::ReportReason
  • Mangadex::ScanlationGroup
  • Mangadex::Tag
  • Mangadex::Upload
  • Mangadex::User
  • Mangadex::MangadexObject
  • Mangadex::Types
  • Mangadex::Version
@thedrummeraki thedrummeraki self-assigned this Sep 23, 2021
@thedrummeraki thedrummeraki added the documentation Improvements or additions to documentation label Sep 23, 2021
@royalgiant
Copy link
Contributor

You rule dude, will be looking into this for my project and helping add PRs whenever bugs are found.

@thedrummeraki
Copy link
Owner Author

Hey @royalgiant thank you! Let me know if you need any help with using the gem. I haven't updated it in a while since the Mangadex API doesn't change much, but I'm planning on going back soon to iron out certain things.

@royalgiant
Copy link
Contributor

@thedrummeraki do you have any idea how to create a proxy to get the images through? Just learned that unless it's through a proxy, I cannot get the images from my deployed app on Heroku.

Screen Shot 2022-11-25 at 10 01 30 PM

@thedrummeraki
Copy link
Owner Author

Hey there @royalgiant, I'm also having the same issue on mine :/ (https://dexify.herokuapp.com/mangas/browse). I think using a proxy service works well. I never personally bothered with writing one from scratch (though it would be pretty easy with a lightweight framework like Sinatra or NodeJS runtime).

I have a project where I came up with a solution to serve images through a route (on Rails), download the image and serve it. Not performant but a good workaround for that project in particular (see it in action here). It works well here because I'm lazy loading images, but may not work in the case of showing up a bunch of covers

@royalgiant
Copy link
Contributor

royalgiant commented Nov 26, 2022 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants