docs(document): describe multi-format course material upload#742
Open
jackefn wants to merge 1 commit into
Open
docs(document): describe multi-format course material upload#742jackefn wants to merge 1 commit into
jackefn wants to merge 1 commit into
Conversation
Collaborator
|
Suggestion on PR structure (not the content): I'd fold this into #741 rather than keep it as a separate docs PR. This PR only touches docs — Two reasons to merge them into one PR:
Standalone docs PRs (revising existing docs, README polish) are totally fine — it's specifically new-feature usage docs that should ride with the implementation. Suggest closing this and moving the README changes into #741. |
13 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the MAIC ETL multi-format course material upload flow.
This PR updates the MinerU/document extraction documentation to describe
/api/extract-document, supported file types, provider selection behavior, server-side MinerU configuration, the compatibility response shape, and the current Milestone 2 scope/non-goals.Related Issues
Related to #621, #611, #41, #140
Changes
.env.localandserver-providers.yml.Type of Change
Verification
Steps to reproduce / test
lib/pdf/README.mdand confirm it describes the current document extraction and multi-format upload behavior.What you personally verified
README.mdandlib/pdf/README.md./api/parse-pdfas a compatibility route while recommending/api/extract-documentfor new upload UI code.Evidence
pnpm check && pnpm lint && npx tsc --noEmit)Local verification:
Checklist