TuringLang / TuringLang/docs

Illustration for hierarchy of TuringLang repos

Open
#606 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Markdown
Stars
238
Forks
107
Avg merge
1d 1h
Merged PRs (30d)
2

Description

In the TuringLang organisation we have lots of repos.

Which of them depend on which of them?

It would be nice to have an illustrated dependency graph that shows how they are all related, e.g.

                 Turing ──────┐             
                 │  │         │             
                 │  │         │             
 MCMCChains ◄────┘  │         │             
     ▲              │         │             
     │              │         │             
     │              ▼         │             
     └─ext──DynamicPPL        │             
                 │  │         │             
                 │  │         │             
                 │  │         ▼             
                 │  └───────► AbstractMCMC  
                 ▼                          
          Bijectors                         

I think fundamentally this would boil down to parsing TOML files, although this might is a bit tricky to get right since we also have package extensions which would probably require a different type of arrow.

Contributor guide

Open the contributing guide

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

Begin by inventorying the TuringLang repositories and the TOML files that describe their dependencies. Determine how package extensions should be represented, then produce an illustrated graph showing repository relationships and distinguishing extension arrows.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
data-visualization, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.