JuliaLang/PackageCompiler.jl

Link to example App.jl file in docs/src/app.md is broken

Open

#1,024 opened on Jan 8, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (200 forks)batch import
buggood first issue

Repository metrics

Stars
 (1,538 stars)
PR merge metrics
 (Avg merge 19d 6h) (4 merged PRs in 30d)

Description

The link at https://github.com/JuliaLang/PackageCompiler.jl/blob/1c35331d8ef81494f054bbc71214811253101993/docs/src/apps.md?plain=1#L203 is broken

The example app uses the artifact system to depend on a very simple toy binary
that does some simple arithmetic. It is instructive to see how the [artifact
file](https://github.com/JuliaLang/PackageCompiler.jl/blob/master/examples/MyApp/Artifacts.toml)
is [used in the source](https://github.com/JuliaLang/PackageCompiler.jl/blob/d722a3d91abe328ebd239e2f45660be35263ebe1/examples/MyApp/src/MyApp.jl#L7-L8).

What version is this supposed to point to?

Contributor guide

Research direction
Inspect the broken link in the documentation. Identify the intended file (examples/MyApp/src/MyApp.jl) in the current repository and update the link to point to a valid version, likely the master branch or a specific release.
Tech stack
julia
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90