JuliaGeometry / JuliaGeometry/GeometryBasics.jl
Improving documentation for GeometryBasics.jl
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 215
- Forks
- 64
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 2
Description
When I was learning Makie.jl, I found that it largely relies on GeometryBasics.jl. However, The current document (https://juliageometry.github.io/GeometryBasics.jl/stable/) could be more user-friendly. Navigating through the documentation has been challenging, as some pages, such as rectangles, polygons, meshes, appear to be blank or nearly blank. Additionally, the lack of tutorials makes it difficult for users to become familiar with both GeometryBasics.jl and Makie.jl.
I think the GeometryBasics.jl is a powerful tool package, since many other packages rely on it. However, the inadequate documentation is hindering new users from learning. I believe that more comprehensive content and tutorials would greatly enhance the learning experience for newcomers.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the current documentation and the rectangles, polygons, and meshes pages first, then consider how GeometryBasics.jl is used with Makie.jl. Done means the blank or nearly blank pages contain useful guidance and tutorials help newcomers learn both packages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100