JuliaIO / JuliaIO/ObjectFile.jl

Publish documentation on GitHub or link to JuliaHub

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

Nobody has claimed this yet.

Dominant language
Julia
Stars
17
Forks
12
PR merge metrics
No merged PRs in 30d

Description

#21 add a basic automated documentation, but this is only available at https://docs.juliahub.com/ObjectFile/iQ45I/, as far as I can tell, and there is no way to get there from this repository.

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 issue #21 and the generated documentation at https://docs.juliahub.com/ObjectFile/iQ45I/. Choose whether the documentation should be published on GitHub or linked from this repository, then verify that users can reach it from the repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.