Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- **`src/linear_algebra_geometry.jl`**: Points, lines, analytic geometry
- **`src/linear_algebra_transform.jl`**: Linear transformations
- **`test/`**: Tests using `Linear_Algebra` and `Test` only — `GeometryBasics`/`LinearAlgebra` names are available via `@reexport`, no explicit `using` needed in test files
- **`docs/`**: Documenter.jl deploying to `https://study.fourm.info/linear_algebra/` (cross-repo to `math_tech_study`)
- **`docs/`**: Documenter.jl deploying to `https://fourm.info/linear_algebra/` (cross-repo to `math_tech_study`)
- **`notebooks/`**: Jupyter notebooks for exploration (not tested in CI)

## Julia Workspace Layout
Expand Down
2 changes: 1 addition & 1 deletion .github/instructions/docs.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ See `documenter-jl-conventions` skill for section anchor rules and examples.
## Documentation Structure

- **Cross-Repository Deployment**: Deploys to math_tech_study repository
- **Subdirectory Pattern**: Available at study.fourm.info/linear_algebra/
- **Subdirectory Pattern**: Available at fourm.info/linear_algebra/
- **Auto-docs Integration**: Uses `@autodocs` for automatic function documentation
- **Mathematical Notation**: Supports LaTeX rendering in documentation

Expand Down
11 changes: 6 additions & 5 deletions .github/instructions/project.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,18 @@ This is **one subrepository** in a multi-repository Julia math study project. Un

## The Math & Tech Study Hub

The main website lives at **https://study.fourm.info** and is built with:
The main website lives at **https://fourm.info** and is built with:
- **Franklin.jl** (Lanyon template) in a separate GitHub repository: `FourMInfo/math_tech_study`
- The main site handles the top-level domain, navigation, and study guides

Current subrepositories and their deployed URLs:
| Repository | Deployed URL |
|---|---|
| `FourMInfo/Linear_Algebra` (this repo) | https://study.fourm.info/linear_algebra/ |
| `FourMInfo/Math_Foundations` | https://study.fourm.info/math_foundations/ |
| `FourMInfo/Linear_Algebra` (this repo) | https://fourm.info/linear_algebra/ |
| `FourMInfo/Math_Foundations` | https://fourm.info/math_foundations/ |
| `FourMInfo/Calculus` | https://fourm.info/calculus/ |

Additional subrepositories (Calculus, etc.) will be added in the future following the same pattern.
Additional subrepositories will be added in the future following the same pattern.

## How This Repository Deploys

Expand All @@ -32,7 +33,7 @@ Push to main
→ CI.yml runs deploy-docs job
→ docs/make.jl builds Documenter site
→ deploydocs() cross-deploys to FourMInfo/math_tech_study (gh-pages branch)
→ Appears at study.fourm.info/linear_algebra/
→ Appears at fourm.info/linear_algebra/
```

Key facts about `docs/make.jl`:
Expand Down
2 changes: 1 addition & 1 deletion .github/instructions/testing.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ CI=true julia --project=. test/runtests.jl

- **Tests**: Run on all PRs (`.github/workflows/CI.yml`)
- **Docs Build**: Test on PR (no deploy)
- **Docs Deploy**: Auto-deploy to `https://study.fourm.info/linear_algebra/` on merge to `main`
- **Docs Deploy**: Auto-deploy to `https://fourm.info/linear_algebra/` on merge to `main`
- **Cross-Repo**: Deploys to `FourMInfo/math_tech_study` subdirectory

## CI Considerations
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ julia --project=. -e "using LiveServer; serve(dir=\"docs/build\")"

### **Documentation Deployment**

- **Automatic**: Documentation deploys to https://study.fourm.info/linear_algebra/ after PR merge
- **Automatic**: Documentation deploys to https://fourm.info/linear_algebra/ after PR merge
- **Cross-Repository**: This repo deploys to a subdirectory of the main study site
- **Manual Trigger**: Maintainers can trigger manual documentation builds if needed

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ package. Subsequent `julia --project=./notebooks` invocations will resolve

Documentation is deployed cross-repo to the Math & Tech Study Hub:

<https://study.fourm.info/linear_algebra/dev/>
<https://fourm.info/linear_algebra/dev/>
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ if CI
deploydocs(
# `repo` MUST be set correctly. Once your GitHub name is set
# the auto-generated documentation will be hosted at:
# https://study.fourm.info/linear_algebra/
# https://fourm.info/linear_algebra/
# (assuming you have enabled `gh-pages` deployment)
repo = "github.com/FourMInfo/math_tech_study.git",
target = "build",
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The code in this package is not meant to be a complete implementation of the mat

Besides the package documentation, you will also find in the left navigation tab links to documents explaining topics from the source books. These often provide more details than covered in the books. Currently, there are two sections: Basics and Geometry.

The Basics documentation section covers the algebraic foundations of linear algebra, including vectors, matrices, systems of equations and analytic geometry. The source of the documents in this section is the book [_Foundations of Mathematics: A Preparatory Course_](https://link.springer.com/book/10.1007/978-3-662-67809-1). by Guido Walz, Frank Zeilfelder and Thomas Rießinger. The earlier contents of this book cover basic mathematical concepts, and documentation and code for those topics can be found in the [Math_Foundations](https://study.fourm.info/math_foundations/dev/sites/) package.
The Basics documentation section covers the algebraic foundations of linear algebra, including vectors, matrices, systems of equations and analytic geometry. The source of the documents in this section is the book [_Foundations of Mathematics: A Preparatory Course_](https://link.springer.com/book/10.1007/978-3-662-67809-1). by Guido Walz, Frank Zeilfelder and Thomas Rießinger. The earlier contents of this book cover basic mathematical concepts, and documentation and code for those topics can be found in the [Math_Foundations](https://fourm.info/math_foundations/dev/sites/) package.

All the documents in this section have been carefully reviewed for content and accuracy. You can check out the [Jupyter notebook](https://github.com/FourMInfo/Linear_Algebra/blob/main/notebooks/Linear_Algebra_Basics.ipynb) associated with this documentation to see worked out examples of concepts covered in the text. Below you can find full documentation of the source files related to this notebook whose functions are exported by the package's module.

Expand Down
8 changes: 4 additions & 4 deletions docs/src/sites.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This site is one of several documentation sites for my personal math and technol

The main sites can be found at:

- [Main Study Site](https://study.fourm.info/)
- [Main Study Site](https://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/)
- [Calculus Docs](https://study.fourm.info/calculus/)
- [Linear Algebra Docs - the current site (this site)](https://fourm.info/linear_algebra/)
- [Math Foundations Docs](https://fourm.info/math_foundations/)
- [Calculus Docs](https://fourm.info/calculus/)