Fix more links (xgi-org#594)

* Fix README and PyPI links * Fix additional links * Update XGI in 5 minutes.ipynb * Update XGI in 1 minute.ipynb * Try again
thomasrobiglio · Sep 12, 2024 · 5dc6f4f · 5dc6f4f
1 parent 5770e59
commit 5dc6f4f
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 * [**Bug reports**](https://github.com/xgi-org/xgi/issues)
 * [**GitHub Discussions**](https://github.com/xgi-org/xgi/discussions)
 * [**Documentation**](https://xgi.readthedocs.io)
-* [**Contributors**](https://xgi.readthedocs.io/en/stable/contributors.html)
+* [**Contribute**](https://xgi.readthedocs.io/en/stable/contribute.html)
 * [**Projects using XGI**](https://xgi.readthedocs.io/en/stable/using-xgi.html)
 
 Sign up for our [mailing list](http://eepurl.com/igE6ez) and follow XGI on [Twitter](https://twitter.com/xginets) or [Mastodon](https://mathstodon.xyz/@xginets)!
@@ -22,14 +22,14 @@ Sign up for our [mailing list](http://eepurl.com/igE6ez) and follow XGI on [Twit
 - [What is XGI?](#what-is-xgi)
 - [Installation](#installation)
 - [Getting Started](#getting-started)
-- [Corresponding Data](#corresponding-data)
+- [XGI-DATA](#xgi-data)
 - [How to Contribute](#how-to-contribute)
 - [How to Cite](#how-to-cite)
 - [License](#license)
 - [Funding](#funding)
 - [Other Resources](#other-resources)
 
-## What is XGI?
+## What is XGI?<a id="what-is-xgi"></a>
 
 Comple**X** **G**roup **I**nteractions (**XGI**) is a Python package for higher-order networks (If you want more information on what higher-order networks are, see our [brief introduction](https://xgi.readthedocs.io/en/stable/higher-order.html)).
 
@@ -41,7 +41,7 @@ Comple**X** **G**roup **I**nteractions (**XGI**) is a Python package for higher-
 * **Manipulate node and edge statistics** in a flexible and customizable way.
 * Draw higher-order networks in a variety of **visually striking ways** (See our [gallery](https://xgi.readthedocs.io/en/stable/gallery.html) for several examples.)
 
-## Installation
+## Installation<a id="installation"></a>
 XGI runs on Python 3.8 or higher.
 
 To install the latest version of XGI, run the following command:
@@ -63,15 +63,15 @@ pip install -e ."[all]"
 For more installation options, see the [guide](https://github.com/xgi-org/xgi/blob/main/requirements/README.md).
 
 
-## Getting Started
-To get started, take a look at the [tutorials](https://xgi.readthedocs.io/en/stable/api/tutorials.html) illustrating the library's basic functionality.
+## Getting Started<a id="getting-started"></a>
+To get started, take a look at the [user guides](https://xgi.readthedocs.io/en/stable/user_guides.html) illustrating the library's basic functionality.
 
 
-## Corresponding Data
+## XGI-DATA<a id="xgi-data"></a>
 A number of higher-order datasets are available in the [XGI-DATA repository](https://github.com/xgi-org/xgi-data) and can be easily accessed with the `load_xgi_data()` function.
 
 
-## How to Contribute
+## How to Contribute<a id="how-to-contribute"></a>
 If you want to contribute to this project, please make sure to read the
 [contributing guidelines](https://github.com/xgi-org/xgi/blob/main/HOW_TO_CONTRIBUTE.md). We expect respectful and kind interactions by all contributors and users as laid out in our [code of conduct](https://github.com/xgi-org/xgi/blob/main/CODE_OF_CONDUCT.md).
 
@@ -86,7 +86,7 @@ Some concrete ways that you can get involved:
 * **Join our [Zulip channel](https://xgi.zulipchat.com/join/7agfwo7dh7jo56ppnk5kc23r/)** to be a part of the daily goings-on of XGI.
 
 
-## How to Cite
+## How to Cite<a id="how-to-cite"></a>
 We acknowledge the importance of good software to support research, and we note that research becomes more valuable when it is communicated effectively. To demonstrate the value of XGI, we ask that you cite the XGI [paper](https://doi.org/10.21105/joss.05162) in your work. You can cite XGI either by going to our repository page [repository page](https://github.com/xgi-org/xgi) (if you haven't already) and clicking the "cite this repository" button on the right sidebar (which will generate a citation in your preferred format) or by copying the following BibTeX entry:
 ```
 @article{Landry_XGI_2023,
@@ -104,13 +104,13 @@ We acknowledge the importance of good software to support research, and we note
 }
 ```
 
-## License
+## License<a id="license"></a>
 Released under the 3-Clause BSD license (see [`LICENSE.md`](https://github.com/xgi-org/xgi/blob/main/LICENSE.md))
 
 Copyright (C) 2021-2024 XGI Developers
 
-## Funding
+## Funding<a id="funding"></a>
 The XGI package has been supported by NSF Grant 2121905, ["HNDS-I: Using Hypergraphs to Study Spreading Processes in Complex Social Networks"](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2121905).
 
-## Other Resources
+## Other Resources<a id="other-resources"></a>
 This library may not meet your needs and if this is this case, consider checking out our [list of other resources](https://github.com/xgi-org/xgi/blob/main/OTHER_RESOURCES.md).
diff --git a/tutorials/getting_started/XGI in 1 minute.ipynb b/tutorials/getting_started/XGI in 1 minute.ipynb
@@ -226,7 +226,7 @@
    "source": [
     "## Wrapping Up\n",
     "\n",
-    "Time flies! Don't forget to check out tutorials [here](https://xgi.readthedocs.io/en/stable/api/tutorials.html)! And guess what? XGI doesn't stop at hypergraphs — it can handle [simplicial complexes](https://xgi.readthedocs.io/en/stable/api/core/xgi.core.simplicialcomplex.SimplicialComplex.html) and [directed hypergraphs](https://xgi.readthedocs.io/en/stable/api/core/xgi.core.dihypergraph.DiHypergraph.html) too!"
+    "Time flies! Don't forget to check out our [user guides](https://xgi.readthedocs.io/en/stable/user_guides.html)! And guess what? XGI doesn't stop at hypergraphs — it can handle [simplicial complexes](https://xgi.readthedocs.io/en/stable/api/core/xgi.core.simplicialcomplex.SimplicialComplex.html) and [directed hypergraphs](https://xgi.readthedocs.io/en/stable/api/core/xgi.core.dihypergraph.DiHypergraph.html) too!"
    ]
   }
  ],

diff --git a/tutorials/getting_started/XGI in 15 minutes.ipynb b/tutorials/getting_started/XGI in 15 minutes.ipynb
@@ -670,7 +670,7 @@
    "source": [
     "## Wrapping Up\n",
     "\n",
-    "Well done! 👏 You've covered a lot in just 15 minutes with XGI. We hope you enjoyed this tutorial, and there's much more to explore! Check out other tutorials [here](https://xgi.readthedocs.io/en/stable/api/tutorials.html)!"
+    "Well done! 👏 You've covered a lot in just 15 minutes with XGI. We hope you enjoyed this tutorial, and there's much more to explore! Check out other tutorials [here](https://xgi.readthedocs.io/en/latest/user_guides.html)!"
    ]
   }
  ],

diff --git a/tutorials/getting_started/XGI in 5 minutes.ipynb b/tutorials/getting_started/XGI in 5 minutes.ipynb
@@ -407,7 +407,7 @@
    "source": [
     "## Wrapping Up\n",
     "\n",
-    "Well done! 👏 You've covered a lot in just 5 minutes with XGI. We hope you enjoyed this tutorial, and there's much more to explore! Check out other tutorials [here](https://xgi.readthedocs.io/en/stable/api/tutorials.html)!"
+    "Well done! 👏 You've covered a lot in just 5 minutes with XGI. We hope you enjoyed this tutorial, and there's much more to explore! Check out other tutorials [here](https://xgi.readthedocs.io/en/stable/user_guides.html)!"
    ]
   }
  ],