oasisprotocol / oasisprotocol/docs
Document best practices when adding images to documentation
Open
Nobody has claimed this yet.
images
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
Some obvious steps would be:
- Document how to choose an appropriate image format (JPG, PNG).
- Add CLI command that automatically reduces size of images.
- Document how to apply it before adding images to git history.
- Document how to sensibly name images.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
No files, tests, or CLI entry point are named; start by locating the documentation section for images and any existing image-size tooling. Done means the documentation covers format choice, size reduction, pre-commit use, and naming, with the requested CLI command's behavior and usage clearly documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100