Documentation improvements (#255)

* add link to paper in README and docs * fix docs link in setup.cfg
AI-SDC · Feb 27, 2025 · 7529e92 · 7529e92
1 parent 26d1045
commit 7529e92
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -51,6 +51,7 @@ See the example notebooks for:
 ### Documentation
 
 The github-pages contains pre-built [documentation](https://ai-sdc.github.io/ACRO/).
+Additionally, see our [paper describing the SACRO framework](https://arxiv.org/abs/2212.02935) to learn about its principle-based SDC methodology and usage.
 
 ### Training Materials
 

diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
@@ -6,6 +6,8 @@ What is ACRO?
 
 A collection of tools for the automatic checking of research outputs.
 
+See our `paper describing the SACRO framework <https://arxiv.org/abs/2212.02935>`__ to learn about its principle-based SDC methodology and usage.
+
 Examples
 --------
 

diff --git a/setup.cfg b/setup.cfg
@@ -32,7 +32,7 @@ keywords =
     statistical-software
 project_urls =
     Changelog = https://github.com/AI-SDC/ACRO/CHANGELOG.md
-    Documentation = https://github.com/AI-SDC/ACRO/wiki
+    Documentation = https://ai-sdc.github.io/ACRO/
     Bug Tracker = https://github.com/AI-SDC/ACRO/issues
     Discussions = https://github.com/AI-SDC/ACRO/discussions
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,8 @@ What is ACRO? @@
     A collection of tools for the automatic checking of research outputs.
+    See our `paper describing the SACRO framework <https://arxiv.org/abs/2212.02935>`__ to learn about its principle-based SDC methodology and usage.
     Examples
     --------
@@ Expand Down @@