From 7bf4902beadc9fdf6c62b9728c0dad84cdfc079b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Wed, 18 Dec 2024 07:08:51 +0100 Subject: [PATCH] docs: add central note about experimental functions (#1624) --- README.md | 6 ++++++ _pkgdown.yml | 3 +++ 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 9d38723c30..a8daa45771 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,12 @@ See the [Installation FAQ](https://r.igraph.org/articles/installation-troublesho See the [igraph package's website](https://r.igraph.org/) for the complete manual. +A good entry point is the "Get started" vignette, in [English](https://r.igraph.org/articles/igraph.html) or [Spanish](https://r.igraph.org/articles/igraph_ES.html). + +For an overview of igraph's functionality see the [reference index](https://r.igraph.org/reference/index.html). +It includes [experimental functions](https://r.igraph.org/reference/index.html#experimental-functions) on which we especially welcome feedback +(but feedback on any function is appreciated)! + ## Contributions Please read our diff --git a/_pkgdown.yml b/_pkgdown.yml index defd64c22b..ea39a9ab2a 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -226,6 +226,9 @@ reference: - title: Versions - contents: - has_concept("versions") +- title: Experimental functions + contents: + - has_lifecycle("experimental") - title: internal contents: - igraph-package