From 8bca44526eaddb63f2a8dbf6cecfa0ac5befd9a5 Mon Sep 17 00:00:00 2001 From: Anshul Singhvi Date: Mon, 8 Jul 2024 07:52:32 +0200 Subject: [PATCH] Add "How to navigate the docs" to index.md (#171) --- docs/src/index.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/src/index.md b/docs/src/index.md index 4b378ef98..d92f04d9f 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -41,7 +41,7 @@ features:
-

What is GeometryOps.jl?

+# What is GeometryOps.jl? GeometryOps.jl is a package for geometric calculations on (primarily 2D) geometries. @@ -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. + +