Add documentation catalog for VectorModule and MatrixModule

wigging · Dec 30, 2024 · 765a814 · 765a814
1 parent 375e24b
commit 765a814
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 49 deletions.
diff --git a/Sources/MatrixModule/Documentation.docc/MatrixModule.md b/Sources/MatrixModule/Documentation.docc/MatrixModule.md
@@ -0,0 +1,9 @@
+# ``MatrixModule``
+
+Two-dimensional matrix operations.
+
+## Overview
+
+This module provides the ``Matrix`` structure for working with two-dimensional numerical data. Arithmetic and several linear algebra operations are supported via protocols. Scalar values can be Int, Float, or Double. See the topics below for more information. 
+
+## Topics
diff --git a/Sources/Numerix/Documentation.docc/DotProduct.md b/Sources/Numerix/Documentation.docc/DotProduct.md
diff --git a/Sources/Numerix/Documentation.docc/MatrixArithmetic.md b/Sources/Numerix/Documentation.docc/MatrixArithmetic.md
diff --git a/Sources/Numerix/Documentation.docc/Numerix.md b/Sources/Numerix/Documentation.docc/Numerix.md
@@ -1,33 +1,22 @@
 # ``Numerix``
 
-An open-source Swift package for numerical computing on Apple devices.
+Linear algebra and numerical computing with Swift on Apple devices.
 
 ## Overview
 
-Numerix is an open-source Swift package that provides vector and matrix types for performing linear algebra and other numerical computations on Apple devices. It uses the Accelerate framework to perform high-performance and energy-efficient calculations. See the sections below to learn more about the package.
+Numerix is an open-source Swift package that provides Vector and Matrix structures for performing linear algebra and other numerical computations on Apple devices. It uses the Accelerate framework for high-performance and energy-efficient calculations. See the module documentation for more information about the Vector and Matrix structures.
 
 ## Contributing
 
-See the `CONTRIBUTING.md` document in the Numerix [GitHub repository](https://github.com/wigging/numerix) for contributing guidelines.
+See the `CONTRIBUTING.md` document in the [Numerix GitHub repository](https://github.com/wigging/numerix) for contributing guidelines.
 
 ## Topics
 
 ### Essentials
 
 - <doc:GetStarted>
-- <doc:BlasRoutines>
-- <doc:LapackRoutines>
-
-### Numeric structures
-
-- ``Vector``
-- ``Matrix``
-
-### Arithmetic operations
-
-- <doc:VectorArithmetic>
-- <doc:MatrixArithmetic>
 
 ### Linear algebra
 
-- <doc:DotProduct>
+- <doc:BlasRoutines>
+- <doc:LapackRoutines>
diff --git a/Sources/Numerix/Documentation.docc/VectorArithmetic.md b/Sources/Numerix/Documentation.docc/VectorArithmetic.md
diff --git a/Sources/VectorModule/Documentation.docc/VectorModule.md b/Sources/VectorModule/Documentation.docc/VectorModule.md
@@ -0,0 +1,9 @@
+# ``VectorModule``
+
+One-dimensional vector operations.
+
+## Overview
+
+This module provides the ``Vector`` structure for working with one-dimensional numerical data. Arithmetic and several linear algebra operations are supported. See the topics below for more details. Scalar values can be Float or Double and limited support is provided for Int values.
+
+## Topics