diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index b36d208..be4a7f8 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -11,7 +11,7 @@ - **`src/Math_Foundations.jl`**: Main module with CI-aware plotting (auto-detects headless environments) - **`src/basic_maths.jl`**: Mathematical library (roots, polynomials, hyperbolas, financial calculations) - **`test/`**: 54 tests with separated computational/plotting logic for CI compatibility -- **`docs/`**: Documenter.jl deploying to `https://study.fourm.info/math_foundations/` (cross-repo to `math_tech_study`) +- **`docs/`**: Documenter.jl deploying to `https://fourm.info/math_foundations/` (cross-repo to `math_tech_study`) - **`notebooks/`**: Jupyter notebooks for exploration (not tested in CI) ## Julia Workspace Layout diff --git a/.github/instructions/docs.instructions.md b/.github/instructions/docs.instructions.md index 3199350..02ada47 100644 --- a/.github/instructions/docs.instructions.md +++ b/.github/instructions/docs.instructions.md @@ -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/math_foundations/ - **Auto-docs Integration**: Uses `@autodocs` for automatic function documentation - **Mathematical Notation**: Supports LaTeX rendering in documentation diff --git a/.github/instructions/project.instructions.md b/.github/instructions/project.instructions.md index e56820a..2426af7 100644 --- a/.github/instructions/project.instructions.md +++ b/.github/instructions/project.instructions.md @@ -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` | https://study.fourm.info/linear_algebra/ | -| `FourMInfo/Math_Foundations` (this repo) | https://study.fourm.info/math_foundations/ | +| `FourMInfo/Linear_Algebra` | https://fourm.info/linear_algebra/ | +| `FourMInfo/Math_Foundations` (this repo) | 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 @@ -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/math_foundations/ + → Appears at fourm.info/math_foundations/ ``` Key facts about `docs/make.jl`: diff --git a/.github/instructions/testing.instructions.md b/.github/instructions/testing.instructions.md index fba472a..e8fbb8f 100644 --- a/.github/instructions/testing.instructions.md +++ b/.github/instructions/testing.instructions.md @@ -99,7 +99,7 @@ end - **CI Compatibility**: Plotting tests with environment detection - **Comprehensive Coverage**: Test both happy path and edge cases - **Type Validation**: Verify return types match expectations -- **Testing Structure**: Modular test files (`test_linear_algebra_basic.jl`, `test_linear_algebra_transform.jl`) +- **Testing Structure**: Modular test files (`test_basic_maths.jl`) ## Plotting in Tests @@ -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/math_foundations/` on merge to `main` - **Cross-Repo**: Deploys to `FourMInfo/math_tech_study` subdirectory ## CI Considerations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4797fe9..a4d6047 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,7 +81,7 @@ julia --project=. -e "using LiveServer; serve(dir=\"docs/build\")" ### **Documentation Deployment** -- **Automatic**: Documentation deploys to after PR merge +- **Automatic**: Documentation deploys to 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 diff --git a/README.md b/README.md index 88a94e7..111a7fa 100644 --- a/README.md +++ b/README.md @@ -55,4 +55,4 @@ package. Subsequent `julia --project=./notebooks` invocations will resolve Documentation is deployed cross-repo to the Math & Tech Study Hub: - + diff --git a/docs/make.jl b/docs/make.jl index 7ed1c6c..3c6492b 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -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/math_foundations/ + # https://fourm.info/math_foundations/ # (assuming you have enabled `gh-pages` deployment) repo = "github.com/FourMInfo/math_tech_study.git", target = "build", diff --git a/docs/src/sites.md b/docs/src/sites.md index 86d08a7..cdd1cd7 100644 --- a/docs/src/sites.md +++ b/docs/src/sites.md @@ -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](https://study.fourm.info/linear_algebra/) -- [Math Foundations Docs - the current site (this site)](https://study.fourm.info/math_foundations/) -- [Calculus Docs](https://study.fourm.info/calculus/) +- [Linear Algebra Docs](https://fourm.info/linear_algebra/) +- [Math Foundations Docs - the current site (this site)](https://fourm.info/math_foundations/) +- [Calculus Docs](https://fourm.info/calculus/)