Skip to content

Commit

Permalink
Add "How to navigate the docs" to index.md (#171)
Browse files Browse the repository at this point in the history
  • Loading branch information
asinghvi17 authored Jul 8, 2024
1 parent 21c92f6 commit 8bca445
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ features:
<div class="vp-doc" style="width:80%; margin:auto">
<h1> What is GeometryOps.jl? </h1>
# What is GeometryOps.jl?
GeometryOps.jl is a package for geometric calculations on (primarily 2D) geometries.
Expand All @@ -51,6 +51,16 @@ Most of the usecases are driven by GIS and similar Earth data workflows, so this
We welcome contributions, either as pull requests or discussion on issues!
# How to navigate the docs
GeometryOps' [docs](https://juliageo.org/GeometryOps.jl/stable) are divided into three main sections: tutorials, explanations and source code.
Documentation and examples for many functions can be found in the source code section, since we use literate programming in GeometryOps.
- Tutorials are meant to teach the fundamental concepts behind GeometryOps, and how to perform certain operations.
- Explanations usually contain little code, and explain in more detail how GeometryOps works.
- Source code usually contains explanations and examples at the top of the page, followed by annotated source code from that file.
</div>
Expand Down

0 comments on commit 8bca445

Please # to comment.