Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
94 commits
Select commit Hold shift + click to select a range
a9f26ad
Frank's changes in DGAlgebras
eisenbud Sep 26, 2023
91254fb
merging
eisenbud Sep 26, 2023
600376e
new AInfinity
eisenbud Jun 4, 2024
74a9ff3
merge
eisenbud Jun 4, 2024
ea6e756
Merge branch 'master' into development
eisenbud Jun 4, 2024
c02abe4
Merge branch 'development' of github.com:Macaulay2/M2 into development
eisenbud Oct 24, 2024
96008ee
Merge branch 'development' of github.com:Macaulay2/M2 into development
eisenbud Oct 30, 2024
4d1616d
Merge branch 'development' of github.com:Macaulay2/M2 into development
eisenbud Oct 31, 2024
dba0809
Add documentation workflow scaffolding
aalmousa Apr 24, 2026
050e58f
Update docs workflow guidance and labels
aalmousa Apr 25, 2026
fdc74f6
Add documentation contributor guides
aalmousa Apr 25, 2026
94583e7
Align documentation guides with upstream docs style
aalmousa Apr 25, 2026
267d05f
Shorten documentation style guide
aalmousa Apr 25, 2026
2e42f75
Add remaining docs refresh backlog gaps
aalmousa Apr 25, 2026
40c39a8
Merge remote-tracking branch 'M2/stable' into sync-doc-updates
aalmousa May 14, 2026
fe4190b
Add Macaulay2Doc landing page refresh plan
aalmousa May 14, 2026
81c33d0
Merge documentation guide and style guide
aalmousa May 14, 2026
62373ca
remove installMinPrimes method that doesnt do anything
joel-dodge May 17, 2026
5624dbe
document default startegy and add links
joel-dodge May 17, 2026
37289a7
example that breaks with a likely bug
joel-dodge May 17, 2026
c2ed715
remove empty docs page boilerplate
joel-dodge May 18, 2026
c79b081
cleanup tensor docs
joel-dodge May 17, 2026
b072c60
document strategy for primary decomposition
joel-dodge May 18, 2026
5fbb8b6
add some examples
joel-dodge May 18, 2026
6d5d287
spell
joel-dodge May 18, 2026
6e538d2
Merge branch 'development' of github.com:Macaulay2/M2 into development
eisenbud May 16, 2026
30bbacb
worked on local rings and primary decomposition
eisenbud May 17, 2026
aa1df39
Merge pull request #385 from eisenbud/DocWork
aalmousa May 17, 2026
dc988ab
Merge pull request #384 from joel-dodge/documentation-refresh
aalmousa May 17, 2026
e68a027
fixes
eisenbud May 18, 2026
7233790
Add Numerical algebraic geometry tutorial (incomplete)
klee669 May 17, 2026
adcb335
fixing the files docs
eisenbud May 18, 2026
2a9252f
doc for kernel
eisenbud May 18, 2026
2105e94
Refresh commutative algebra teaching materials entry
aalmousa May 18, 2026
c131b33
Refresh commutative algebra tutorial load entry
aalmousa May 18, 2026
1bffde7
Fix tensorAssociativity documentation example
aalmousa May 18, 2026
37fdc70
Improve concept-to-command documentation guidance
aalmousa May 18, 2026
99efd0c
Fix Macaulay2Doc targeted install blockers
aalmousa May 18, 2026
8183814
Reorganize core algebra documentation navigation
aalmousa May 18, 2026
09d7764
Merge pull request #389 from joel-dodge/primary-decomposition-updates
aalmousa May 18, 2026
928fe76
Add Triplet documentation example
aalmousa May 18, 2026
8e67975
Add attemptsAtGenericReduction documentation example
aalmousa May 18, 2026
627c5e6
Add SymmetricPolynomials package example
aalmousa May 18, 2026
6b6c8a6
Update author emails and MatrixSchubert references
aalmousa May 18, 2026
b7e15f8
Add Tableaux package example
aalmousa May 18, 2026
fb1b2d4
Add SimplicialPosets package example
aalmousa May 18, 2026
54349bb
Add LineageTable documentation example
aalmousa May 18, 2026
9200dc4
Add StronglyStableIdeals package example
aalmousa May 18, 2026
f506cfc
Add package examples for fitting ideals and Fourier-Motzkin
aalmousa May 18, 2026
7eff552
Update package documentation examples and TODOs
aalmousa May 19, 2026
4db1bd6
Add RandomIdeals AlexanderProbability example
aalmousa May 19, 2026
3ba8ee5
Add package documentation examples
aalmousa May 19, 2026
017eb03
Merge pull request #388 from eisenbud/DocWork
eisenbud May 18, 2026
d1b0153
Update numerical packages documentation
klee669 May 19, 2026
36746f7
Refresh Macaulay2Doc landing page and computation guides
aalmousa May 18, 2026
9152050
docs: add package landing examples for refresh issues
aalmousa May 19, 2026
4b4af28
Update tu_NAG.m2
klee669 May 19, 2026
9bb32b4
Merge pull request #387 from joel-dodge/tensor-docs
aalmousa May 18, 2026
4c0401f
documented (map, GaloisField, GaloisField)
eisenbud May 18, 2026
d71ffe9
Merge branch 'doc-updates' of github.com:aalmousa/M2 into doc-updates
klee669 May 19, 2026
4812152
Merge pull request #386 from joel-dodge/update-wedge-product-docs
aalmousa May 18, 2026
1e2ed3b
add examples and docs for kernel method
joel-dodge May 19, 2026
0167253
forceGB-doc and gb-doc minor updates
eisenbud May 19, 2026
94cc57a
Update tu_NAG.m2
klee669 May 19, 2026
ce049e0
Expand representation theory documentation overview
aalmousa May 18, 2026
4f82b8a
uncomment example lines
joel-dodge May 19, 2026
6084d73
Merge pull request #399 from eisenbud/DocWork
eisenbud May 19, 2026
253627d
Merge pull request #390 from eisenbud/DocWork
eisenbud May 18, 2026
fc150db
tweak descriptions for optional arguments to kernel
joel-dodge May 19, 2026
0c2f91a
docs: add examples for package refresh batch
aalmousa May 19, 2026
3c4c2eb
Completed NAG tutorial
klee669 May 18, 2026
e697085
add caveats
joel-dodge May 19, 2026
adca880
docs: refresh repo entrypoints and workflow guidance
aalmousa May 19, 2026
39a5ff6
Merge pull request #391 from eisenbud/DocWork
eisenbud May 18, 2026
03b9a75
add assert
joel-dodge May 19, 2026
8dd8d47
docs: fix Galois field map docs
aalmousa May 20, 2026
c74418f
missed variable name change in tensor doc examples
joel-dodge May 19, 2026
001791d
Merge pull request #393 from joel-dodge/kernel-docs
aalmousa May 20, 2026
a698bb7
Merge pull request #392 from joel-dodge/fix-tensor-docs-bug
aalmousa May 20, 2026
13b7379
Update Macaulay2 package docs (gin, NAG) and map(GF,GF) documentation…
klee669 May 20, 2026
283a9cf
docs: split tutorials and restructure top-level navigation
aalmousa May 20, 2026
a6a5a7f
Enhance NAG tutorial intro and outline
klee669 May 20, 2026
7e3ad40
docs: fix Macaulay2Doc doc tree and map docs
aalmousa May 21, 2026
0ad178b
Expand debugging documentation with examples
klee669 May 21, 2026
6a1aa27
Merge branch 'doc-updates' of github.com:aalmousa/M2 into doc-updates
klee669 May 21, 2026
881887a
Update author email in package metadata
klee669 May 21, 2026
047243a
Add 'continue' and 'trap' entries to ov_debugging
klee669 May 21, 2026
2ebf720
Fix spacing in debugger doc string
klee669 May 21, 2026
86ca2a3
docs: add beginner Shidoku tutorial
aalmousa May 21, 2026
aa40fc4
docs: fix front page tutorial links
aalmousa May 21, 2026
41b86b7
docs: restore GF map node for package install
aalmousa May 21, 2026
80963ec
docs: move GF map docs to ConwayPolynomials
aalmousa May 21, 2026
35c324c
Merge pull request #400 from joel-dodge/module-tutorial
aalmousa May 21, 2026
6cf4531
Merge pull request #401 from joel-dodge/subquotient-docs
aalmousa May 21, 2026
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
92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: Documentation task
description: File a scoped issue for documentation changes in Macaulay2.
title: "docs: "
labels:
- documentation
body:
- type: dropdown
id: area
attributes:
label: Documentation area
description: Choose the main area affected by this issue.
options:
- Build and install docs
- Internal/reference docs
- Package docs
- Tutorials and examples
- Editor/tooling docs
- Contributor guidance
- Repository-wide cleanup
- Other
validations:
required: true

- type: textarea
id: summary
attributes:
label: Summary
description: State the problem in one short paragraph.
placeholder: What is wrong, unclear, outdated, or missing?
validations:
required: true

- type: textarea
id: paths
attributes:
label: Affected paths
description: List the files or directories likely to change.
placeholder: |
README.md
M2/Macaulay2/docs/index.rst
M2/Macaulay2/packages/SomePackage/README.md
validations:
required: true

- type: textarea
id: desired_outcome
attributes:
label: Desired outcome
description: Describe what "done" looks like for this task.
placeholder: After this issue is complete, what should a reader be able to do or understand?
validations:
required: true

- type: textarea
id: verification
attributes:
label: Verification
description: Say how the updated docs should be checked.
placeholder: |
Example:
- Rerun the commands in the README
- Check links
- Build the relevant docs, if applicable
validations:
required: true

- type: dropdown
id: size
attributes:
label: Estimated size
options:
- Small
- Medium
- Large
validations:
required: true

- type: checkboxes
id: review_flags
attributes:
label: Review flags
options:
- label: This issue needs mathematical review.
- label: This issue needs examples or commands to be rerun.
- label: This issue may require follow-up issues instead of one PR.

- type: textarea
id: dependencies
attributes:
label: Dependencies or blockers
description: Note related issues, required decisions, or blockers.
placeholder: Optional
21 changes: 17 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
<!--
Thank you for contributing to Macaulay2!
## Summary

Please read https://github.com/Macaulay2/M2/wiki/Pull-requests for instructions.
-->
Describe the documentation change and the main files it touches.

## Related Issue

Link the issue in `Macaulay2/M2` or `aalmousa/M2` that this PR addresses.

## Verification

List what you checked locally. Be explicit about examples, links, generated
html, or any verification you could not complete.

## Notes

- Keep the scope focused. Split unrelated documentation work into separate PRs.
- See `README.md` and the Macaulay2 wiki for the current contribution
workflow.
9 changes: 5 additions & 4 deletions M2/BUILD/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
See [INSTALL](../INSTALL) or [INSTALL-CMake.md](../INSTALL-CMake.md) for build
requirements and instructions.
See the [Macaulay2 wiki](https://github.com/Macaulay2/M2/wiki) for current
build requirements and instructions, especially the "Building M2 from source"
pages for the autotools and CMake workflows.

This directory may be used as a convenient location for the build directory
trees. For example, it may contain subdirectories `Linux-i686` and
Expand Down Expand Up @@ -33,5 +34,5 @@ architecture-independent files are in a subdirectory of this directory called
`common`, and the architecture-dependent files will be in other subdirectories,
such as `x86_64-Linux-Ubuntu-8.10`. (Actually, this is being changed...)

Alternatively, see the [this guide](docker/README.md) for instructions on using
Docker to build Linux container images running Macaulay2.
Alternatively, see the [Docker guide](docker/README.md) for instructions on
using Docker to build Linux container images running Macaulay2.
Loading
Loading