JuliaAI / JuliaAI/DataScienceTutorials.jl

Cross-referencing

Open
#82 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tutorial organization
Dominant language
ReScript
Stars
126
Forks
19
PR merge metrics
No merged PRs in 30d

Description

There is currently little cross-referencing between end-to-end Tutos and the 'Labs' or 'Getting started' sections. I think it would help if the Tutos pointed to Labs and other sections for more basic introduction to some of the tools/commands used. And, the other way around, if in these sections there were pointers to the end-to-end tutos which apply them in context.

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

Review the end-to-end Tutos, Labs, and Getting started sections to inventory the tools and commands that need introductory links and the tutorials that should be linked back. Define a consistent cross-reference plan before editing the relevant tutorial pages. Done means the applicable sections link to one another in both directions and the links are valid.

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.