Enhance Linear Algebra Documentation Structure and Navigation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

AronT-TLV merged 2 commits into main from feature/enhance-documentation

Jul 23, 2025

Project.toml

-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a" @@
     LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
     Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
     LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+    LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
     Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
     RationalRoots = "308eb6b3-cc68-5ff3-9e97-c3c4da4fa681"
     Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
@@ Expand Down @@

docs/make.jl

-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,7 @@ makedocs(; @@
         sitename = "Linear_Algebra",
         # This argument is only so that the sequence of pages in the sidebar is configured
         # By default all markdown files in `docs/src` are expanded and included.
-        pages = ["index.md"],
+        pages = ["index.md", "sites.md"],
         # Don't worry about what `CI` does in this line.
         format = Documenter.HTML(
             prettyurls = CI,
@@ Expand Down @@

docs/src/assets/logo.png

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

docs/src/index.md

-Original file line number
+Diff line change
@@ Expand Up @@
     Modules = [Linear_Algebra]
     Order   = [:function, :type]
     Pages   = ["linear_algebra_basic.jl", "linear_algebra_transform.jl"]
-    ```
-    ---
-    ## Navigating FourM Study Guides & Documentation Sites
-    ```@raw html
-    <div class="site-navigation">
-        <div class="nav-section">
-            <h4>Documentation Sites</h4>
-            <ul>
-                <li><a href="https://study.fourm.info/linear_algebra/">Linear Algebra Docs (this site)</a></li>
-                <li><a href="https://study.fourm.info/math_foundations/">Math Foundations Docs</a></li>
-            </ul>
-        </div>
-        <div class="nav-section">
-            <h4>Related Projects</h4>
-            <ul>
-                <li><a href="https://study.fourm.info/">Main Study Site</a></li>
-            </ul>
-        </div>
-    </div>
     ```

docs/src/sites.md

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    # FourM Study Guides & Documentation Sites
+    This site is one of several documentation sites for my personal math and technology study under what I call the FourM project. It is essentially a collection of resources I created to understand various mathematical concepts and software frameworks.
+    The main sites can be found at:
+    - [Main Study Site](https://study.fourm.info/)
+    - [FourM GitHub Repository](https://github.com/fourm)
+    Here are some of the key documentation sites related to my mathematics study:
+    - [Linear Algebra Docs - the current site (this site)](https://study.fourm.info/linear_algebra/)
+    - [Math Foundations Docs](https://study.fourm.info/math_foundations/)

Provide feedback