📝 Document upload functionality #498
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
|
There was a problem hiding this comment.
I took a cursory look towards the end of my lunch today, I had a few comments but otherwise this looks great! Thanks a ton for getting the ball rolling here
Edit to add I refactored the docs a bit on the KoReader feature branch. We have time still, as I don't expect to merge that for another week-ish, but it would be good to get this in first so I can handle the conflicts there.
docs/pages/guides/upload.mdx
Outdated
| ## How it works | ||
|
|
||
| This feature allows users to upload books or an entire collection of files and directories via series upload. | ||
|
|
||
| After an upload finishes, a library scan will automatically be started to add the newly uploaded books. | ||
|
|
||
| ### Uploading books | ||
|
|
||
| Users can upload one or more book files (e.g., `.cbz`, `.cbr`, `.epub`, and `.pdf` files) to a specific library directory. | ||
|
|
||
| ### Uploading Series | ||
|
|
||
| Users can upload a `.zip` file containing multiple books in an arbitrary directory structure. The archive will be extracted to the location specified when uploading. |
There was a problem hiding this comment.
I think it would be nice to use the stepped instruction pattern from a few other places, like the scanner docs. I think your title is much better though (i.e. not making the heading a question)
There was a problem hiding this comment.
Check out what I added. I'm pretty into the InlineIcon component I made (although if there was a pre-existing solution I missed let me know).
I added some steps, although in a slightly different way. Rather than walking through the steps that happen when an upload is done, I walked through the steps a user should take to make an upload happen. I thought that would be a good way to explain each of the upload request fields and what they do from a user's perspective.
There was a problem hiding this comment.
Rather than walking through the steps that happen when an upload is done, I walked through the steps a user should take to make an upload happen
Nice, I think that’s perfect! I’ll also be able to take a look at the component you mentioned tomorrow
Co-authored-by: Aaron Leopold <36278431+aaronleopold@users.noreply.github.com>
Co-authored-by: Aaron Leopold <36278431+aaronleopold@users.noreply.github.com>
Co-authored-by: Aaron Leopold <36278431+aaronleopold@users.noreply.github.com>
I figured we should begin drafting documentation for the upload feature so that when it eventually makes its way down the pipeline there will be something to guide users through enabling it and understanding how to configure and use it.
I'm marking this as a draft to ensure that it meets the style and content expectations for the project.