JuliaArrays / JuliaArrays/StaticArrays.jl

docs revamp: remove 0.6->0.7 migration advice

Open
#716 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
844
Forks
159
Avg merge
3d 21h
Merged PRs (30d)
3

Description

The docs still has a part on migration from 0.6, perhaps it is not very relevant for most people any more.

I would suggest removing this section, then merging the remaining blurb and the API page into one page.

Happy to make a PR, just asking if this would be OK.

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 reading docs/src/index.md and its “Migrating code from Julia v0.6 to Julia v0.7” section, then locate the API page referenced by the issue. Remove the outdated migration advice and merge the remaining blurb with the API page; the documentation should retain the useful content in one page.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.