Where should visual aids be put for training materials and how should they be organised?
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
Is your feature request related to a problem? Please describe.
There's no guidance where to put images/media for documentation and training guides.
Describe the solution you'd like
Add instructions which folder images or other media is placed to training material guide and pipeline documentation, and describe how media from different pages should be organised within that folder, e.g naming, subfolder etc.
Contributor 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.
Research direction
Start by reviewing the training material guide and pipeline documentation to find their current media locations and organization conventions. Document the folder location, naming rules, and subfolder structure for images and other media; the issue is complete when both documentation areas explain how page-specific media should be organized.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100