Proper Documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- aws, python
- Domain
- documentation
Research direction
Review the existing process documentation alongside the repository description of the Textract pipeline, S3 output, and REST API. Document the missing setup and run steps, including prerequisites and how to verify the pipeline is working; the issue does not name specific files or tests to use.
Written by the indexing model from the issue text.
Description
Stumbled upon this repo... would be very helpful if not only was the process documented (which it is), but also setting this repo up and getting it up and running.
- Dominant language
- Python
- Stars
- 19
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
changelog investigate
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
ramnes/notion-sdk-py#409 ·
-
good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
lindicaphxag-tech/kaggle#28 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
BSData/horus-heresy-3rd-edition#3211 ·
Maintainers usually reply within 1 day
-
bug needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
bug tests
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day