Docs cleanup (#1736)

* Remove roadmap * Create workplane.rst * Add text * Restructure primer.rst * Create citing.rst * Add citing to index.rst * Update README.md Mention citing * Add citation.cff * Delete citation.cff.yaml * Create CITATION.cff * Update CITATION.cff * Update CITATION.cff * Update CITATION.cff * Update CITATION.cff * Apply suggestions from code review Co-authored-by: Jeremy Wright <[email protected]> * Add refs * tweak --------- Co-authored-by: Jeremy Wright <[email protected]>
CadQuery · Jan 1, 2025 · 7b9a48d · 7b9a48d
1 parent 0ebfa2b
commit 7b9a48d
Show file tree

Hide file tree

Showing 6 changed files with 582 additions and 553 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,8 @@
+cff-version: 1.2.0
+doi: 10.5281/zenodo.10513848
+license: "Apache 2.0"
+url: https://github.com/CadQuery/cadquery
+title: "CadQuery"
+message: "If you use this software, please cite it using these metadata."
+authors:
+  - name: "CadQuery contributors"
diff --git a/README.md b/README.md
@@ -5,8 +5,7 @@
 [![Build Status](https://dev.azure.com/cadquery/conda-packages/_apis/build/status/CadQuery.cadquery?branchName=master)](https://dev.azure.com/cadquery/conda-packages/_build/latest?definitionId=2&branchName=master)
 [![codecov](https://codecov.io/gh/CadQuery/cadquery/branch/master/graph/badge.svg)](https://codecov.io/gh/CadQuery/cadquery)
 [![Documentation Status](https://readthedocs.org/projects/cadquery/badge/?version=latest)](https://cadquery.readthedocs.io/en/latest/?badge=latest)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4498634.svg)](https://doi.org/10.5281/zenodo.4498634)
-
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4498634.svg)](https://doi.org/10.5281/zenodo.3955118)
 
 ---
 
@@ -230,3 +229,7 @@ When filing a bug report [issue](https://github.com/CadQuery/cadquery/issues), p
 ### How to Suggest a Feature or Enhancement
 
 If you find yourself wishing for a feature that does not exist, you are probably not alone. There are bound to be others out there with similar needs. Open an [issue](https://github.com/CadQuery/cadquery/issues) which describes the feature you would like to see, why you need it, and how it should work.
+
+## Citing
+
+Please use our Zenodo DOI if you use CadQuery for scientific research: https://doi.org/10.5281/zenodo.3955118.
diff --git a/doc/citing.rst b/doc/citing.rst
@@ -0,0 +1,4 @@
+Citing
+======
+
+Please use our Zenodo DOI if you use CadQuery for scientific research: https://doi.org/10.5281/zenodo.3955118.
diff --git a/doc/index.rst b/doc/index.rst
@@ -38,6 +38,7 @@ Table Of Contents
     quickstart.rst
     designprinciples.rst
     primer.rst
+    workplane.rst
     sketch.rst
     assy.rst
     free-func.rst
@@ -51,7 +52,7 @@ Table Of Contents
     importexport.rst
     cqgi.rst
     extending.rst
-    roadmap.rst
+    citing.rst