JuliaImages / JuliaImages/juliaimages.github.io

aggregating the sub-packages' documentation here

Open
#128 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
33
Forks
52
PR merge metrics
No merged PRs in 30d

Description

Currently, documentation of sub-packages are spread outside, common users can easily get lost in finding the correct docs. It would be handier to have a centralized version of documentations for reference usage.

cref: https://github.com/JuliaImages/juliaimages.github.io/pull/125#issuecomment-617137555

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the JuliaImages documentation repository and the referenced discussion in juliaimages.github.io pull request 125. Identify which sub-package documentation must be brought together and define a central reference structure; done means users can find the relevant sub-package documentation from one centralized location.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.