Repair the docs build, and bring the quickstart to 2.0.0 - #32
Merged
Conversation
The generation had been broken since asc-community/AngouriMath@f0db3eef moved the library up a folder on 2026-01-03. Two places still pointed at the old layout: amsite.fsx published from Sources/AngouriMath/AngouriMath, which no longer exists, so `init` failed outright; and NaiveStaticGenerator read AngouriMath.xml from the same stale path, so the almanac would have been empty even if the publish had succeeded. They have to move together, and each now says so. Two more things stopped it independently of that. The generator targeted net6.0, out of support since November 2024 and no longer present on a current machine. And the workflows used actions/checkout@v2 and actions/setup-dotnet@v1, which GitHub no longer runs -- so the deployment could not have succeeded whatever the paths said. Verified end to end on this commit: `init` then `build` produces 1944 pages, the almanac among them, with Latexize present and the members 2.0 removed absent. The quickstart: - Drops --prerelease. 2.0.0 is a release, and the flag was installing a preview against pages that describe something else. - Removes the MyGet instructions. That feed answers but lists no AngouriMath package, and it was retired in asc-community/AngouriMath#701. - Fixes the F# and notebook hello-world programs, which did not compile: they opened Core and Functions by paths that do not resolve and called `parse` and `differentiate`, which are `parsed` and `derivative`. This was the first program a new F# reader runs. - Fixes the C++ snippet, which had a stray semicolon after its #include and no <iostream>. - Says which frameworks the package targets, since a net7.0 project now silently resolves netstandard2.0 and loses generic math with it. The C# and F# hello-world blocks carry an amcheck annotation, so a harness compiles and runs them against a build of the library rather than leaving them to a reader to discover. What's new gets its 2.0.0 entry. PackageReleaseNotes sends every NuGet reader to that page, and its newest entry was 1.4-preview.4 marked "in development".
uninit deletes the AngouriMath, Yadg.NET and wiki clones, and git marks the files under .git/objects/pack read-only. Directory.Delete refuses a read-only file on Windows, so uninit failed there with UnauthorizedAccessException on a pack .idx -- the only red leg of the matrix, with init, build and clean all passing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Merge this after
v2.0.0is published on NuGet — the quickstart tells the reader toinstall a version that has to exist first. Everything else here is a repair and is
independent of that.
The docs build has been broken since 2026-01-03
asc-community/AngouriMath@f0db3eefmoved the library up a folder, and two places here stillpointed at the old layout:
amsite.fsxpublishsrc/AngouriMath/Sources/AngouriMath/AngouriMath.../Sources/AngouriMathNaiveStaticGeneratorreadingAngouriMath.xmlThe first made
dotnet fsi amsite.fsx initfail outright, so nothing downstream ran. Thesecond would have produced an empty almanac even if the publish had succeeded. They have to
move together and each now says so in a comment.
Two further things stopped it independently, so fixing only the paths would not have been
enough:
NaiveStaticGeneratortargetednet6.0, out of support since November 2024 and notpresent on a current machine —
dotnet fsi amsite.fsx buildfails with"To install missing framework… 6.0.0". Now
net10.0.Yadg.NETstays onnet6.0and isreferenced as a library, which is fine.
actions/checkout@v2andactions/setup-dotnet@v1, which GitHub nolonger runs. Now
@v4, onesetup-dotnetat10.xinstead of separate .NET 6 and .NET 7steps, and
github-pages-deploy-action@v4instead of a pinned4.1.4. The ninelslinesthat debugged the old paths are gone, and the deployment job declares
permissions: contents: writefor thegh-pagespush.Verified end to end on this commit:
initthenbuildproduces 1944 pages. The almanacis among them and reflects 2.0 —
docs/AngouriMath/Entity/Latexize.htmlis there,Ceil,Floor,Round,Min,MaxandGcdare there, and the members 2.0 removed are not.Quickstart
--prereleaseis gone. It was installing2.0.0-preview.2against pages describingsomething else.
package, and it was retired in
asc-community/AngouriMath#701. Same for the#iform inthe notebook section.
CoreandFunctionsby paths that do not resolve, and calledparseanddifferentiate, which areparsedandderivative. This was the first program a new F# reader runs.;after its#includeand no<iostream>.net7.0project now resolves thenetstandard2.0asset and loses the generic-math surface with it, and a pointer toBREAKING-CHANGES.mdfor anyone coming from 1.x.The C# and F# hello-world blocks now carry
<!-- amcheck:cs -->/<!-- amcheck:fs -->, so aharness compiles and runs them against a build of the library. Both pass. The annotation is
an HTML comment and does not render. 28 other
pre codeblocks on the site are shell, CMakeor notebook lines and are not annotated; that count is reported rather than passed over.
What's new
PackageReleaseNotesin every published package sends the reader to/whatsnew, whosenewest entry was 1.4-preview.4, marked "in development". Added the 2.0.0 entry: the
renames and removals, the answers that changed because the old ones were wrong, what is new,
and a link to
BREAKING-CHANGES.mdat the top, since several entries are a wrong answerbecoming a right one and that still breaks code built on the wrong one.
1.4-preview.4losesits "[in development]".
Also
README.mdsaid to install .NET 6 to run the site locally; it is .NET 10 now.Related:
asc-community/AngouriMath#883is the release itself, and the wiki has beencorrected and is now machine-checked against a 2.0.0 build (86 samples, 0 compile errors, 0
output mismatches).