Skip to content

Feature/v0.1 docs package 2026 06 01#3

Merged
Robby955 merged 24 commits into
mainfrom
feature/v0.1-docs-package-2026-06-01
Jun 2, 2026
Merged

Feature/v0.1 docs package 2026 06 01#3
Robby955 merged 24 commits into
mainfrom
feature/v0.1-docs-package-2026-06-01

Conversation

@Robby955

@Robby955 Robby955 commented Jun 2, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • New Features

    • Reusable finite dyadic-net chaining/Dudley API plus concrete instantiations for two-point, finite-discrete, and unit-interval index families; packaged projected- and supplied-supremum Dudley bounds.
    • Extended finite-measure union bounds with budget-allocation and equal-split variants.
  • Documentation

    • Major v0.1 docs added/rewritten (quickstart, technical note, artifact map, roadmap, diagrams, multiple handoffs, README updates).
  • Examples & Tools

    • New verification/checker examples and a doc-anchor validation CLI for local verification.

Robby955 added 22 commits May 31, 2026 13:30
…page draft)

README leads with the two checked v0.1 endpoints (finite-class Hoeffding
confidence sequence and the unit-interval finite-net Dudley bridge), a fast
verification path, and an explicit non-claims list. The technical note covers
the verified finite-class confidence sequences and the finite-net Dudley
bridge. The page draft is route-ready for the TheoremPath site.

Verified on this branch: lake build FormalSLT green; the two headline
endpoints print axioms [propext, Classical.choice, Quot.sound].
@coderabbitai

coderabbitai Bot commented Jun 2, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR introduces a reusable finite-dyadic Dudley API (bundled net sequence and Dudley instance), constructors from totally-bounded spaces, concrete instantiations for Bool and Fin n with embedded Rademacher processes, finite-union bound variants, many example/checker files, and extensive documentation and a doc-anchor validation script.

Changes

Finite Dyadic Dudley API and Concrete Instantiations

Layer / File(s) Summary
Reusable Finite Dyadic Net Sequence API
FormalSLT/Covering/FiniteSubGaussianChaining.lean
FiniteDyadicNetSequence bundles finite dyadic nets, radius bounds, and covering constraints; FiniteDyadicDudleyInstance packages coarse expectation budgets and supplies reusable projected and terminal-supremum Dudley bounds; entropy-budget and prefix-envelope support lemmas handle constant and monotone cases.
Total-Bounded Dyadic Bridge
FormalSLT/Covering/TotalBoundedDudley.lean
dyadicChainingFiniteNetSequenceOfTotallyBounded constructs a FiniteDyadicNetSequence from a total-bounded index space; finiteDyadicDudleyInstanceOfTotallyBounded packages it into a FiniteDyadicDudleyInstance with coarse projected-supremum bound and variance hypotheses.
Two-Point Concrete Dudley Example
FormalSLT/Covering/TwoPointDudley.lean
Defines discrete metric on Bool, constructs one-coordinate Rademacher process, dyadic finite nets with radius/covering properties, packages into FiniteDyadicDudleyInstance, and proves both projected and supplied-supremum Dudley bounds on the two-point space.
Finite Discrete (Fin n) Dudley Example
FormalSLT/Covering/FiniteDiscreteDudley.lean
Discrete metric on Fin n (n ≥ 2) with embedded Rademacher process on two distinguished points, dyadic-scaled identity-projection nets, coarse expectation bound, and both projected/supplied-supremum Dudley theorems for finite-discrete families.
Union Bound Variants
FormalSLT/Probability/FiniteUnionBound.lean
Extends base finiteMeasureUnionBound with budget allocation, common per-event, equal-split, and card-inverse forms using ENNReal inverse cancellation.
Module Integration and Verification
FormalSLT.lean, examples/Check*.lean, FormalSLT/VC/SampleComplexity.lean
Imports new covering modules; adds example checker files for finite discrete, union bounds, total-bounded, two-point, uniform convergence, unit-interval, and v0.1 usability; updates VC sample-complexity documentation.
Comprehensive Documentation
README.md, docs/*.md, scripts/check_doc_anchors.py
Rewrites introduction for v0.1 surface (finite-class Hoeffding and unit-interval Dudley), adds library map and expanded scope sections, extends release-candidate and audit checklists, introduces doc anchor validation script, regenerates proof-frontier manifest with expanded theorem families, and adds technical notes, quickstart guides, and TheoremPath pages for v0.1 release candidate.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Poem

🐰 A rabbit scribbles nets on dyadic nights,
Two points, finite fields, and supremum flights,
Bundles tucked with radii halving clean,
Adapters route the bounds where they are seen,
Docs and checkers hop along the lights.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check ❓ Inconclusive The title is vague and uses a non-descriptive branch-naming pattern (Feature/v0.1 docs package 2026 06 01) that doesn't convey the actual changeset content; it lacks specificity about what is being added or changed. Revise the title to clearly describe the main change, such as 'Add v0.1 release documentation and finite dyadic-net API instances' or 'Introduce packaged finite Dudley framework and concrete instantiations'.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/v0.1-docs-package-2026-06-01

Warning

Review ran into problems

🔥 Problems

Stopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a @coderabbit review after the pipeline has finished.


Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/formalslt-v0.1-release-review-2026-06-01.md`:
- Around line 25-28: Replace all machine-specific absolute paths and local
branch names in the memo (e.g. the path string
"/private/tmp/formalslt-nonfinite-unit-interval", the branch identifier
"local/nonfinite-unit-interval-20260531", and user-specific script paths like
"/Users/robsneiderman/Desktop/AI4MATH/scripts/audit_public_writing.py") with
repository-relative paths or neutral placeholders; update references to scripts
to use a relative path from the repo root (or a configurable variable), or mark
the memo as explicitly local/private and remove these absolute paths, and ensure
the memo header (the "local release-candidate memo" phrasing) reflects whether
the file is intended for public commit so readers know to adjust paths for their
environment.

In `@docs/formalslt-v0.1-technical-note.md`:
- Around line 572-574: Replace the machine-specific absolute path with a
repo-relative path or a placeholder: update the command that invokes
audit_public_writing.py so it references the script as
./scripts/audit_public_writing.py (or <path-to-scripts>/audit_public_writing.py)
and keep the output target as docs/formalslt-v0.1-artifact-map-2026-06-01.md;
alternatively add a brief parenthetical note that users must adjust the path to
their environment. Ensure you edit the line containing audit_public_writing.py
in the docs/formalslt-v0.1-technical-note.md so it no longer contains
/Users/robsneiderman/... and instead uses the relative path or placeholder.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b07d37df-dd35-47c5-b8ec-437ad6bc5fbb

📥 Commits

Reviewing files that changed from the base of the PR and between f3c748a and 5ca9082.

📒 Files selected for processing (38)
  • FormalSLT.lean
  • FormalSLT/Covering/FiniteDiscreteDudley.lean
  • FormalSLT/Covering/FiniteSubGaussianChaining.lean
  • FormalSLT/Covering/TotalBoundedDudley.lean
  • FormalSLT/Covering/TwoPointDudley.lean
  • FormalSLT/Covering/UnitIntervalDudley.lean
  • FormalSLT/Probability/FiniteUnionBound.lean
  • FormalSLT/UniformConvergence.lean
  • FormalSLT/VC/SampleComplexity.lean
  • README.md
  • docs/anytime-spine-handoff-2026-06-01.md
  • docs/assumptions-and-nonclaims.md
  • docs/diagrams.md
  • docs/formalslt-goal6-dyadic-net-sequence-handoff-2026-06-01.md
  • docs/formalslt-goal7-second-dyadic-net-instantiation-2026-06-01.md
  • docs/formalslt-v0.1-artifact-map-2026-06-01.md
  • docs/formalslt-v0.1-quickstart.md
  • docs/formalslt-v0.1-release-review-2026-06-01.md
  • docs/formalslt-v0.1-technical-note.md
  • docs/proof-frontier-manifest.json
  • docs/proof-frontier.md
  • docs/public-release-checklist.md
  • docs/related-work.md
  • docs/roadmap.md
  • docs/superpowers/plans/2026-06-01-finite-dyadic-net-sequence.md
  • docs/theorem-map.md
  • docs/theorempath-formalslt-v0.1-page-draft.mdx
  • docs/unit-interval-dudley.md
  • docs/verified-slt-program-outline.md
  • examples/CheckFiniteDiscreteDudley.lean
  • examples/CheckFiniteUnionBound.lean
  • examples/CheckTotalBoundedDudley.lean
  • examples/CheckTwoPointDudley.lean
  • examples/CheckUniformConvergence.lean
  • examples/CheckUnitIntervalDudley.lean
  • examples/CheckV01Usability.lean
  • scripts/check_doc_anchors.py
  • scripts/generate_proof_frontier_manifest.py

Comment on lines +25 to +28
- Path: `/private/tmp/formalslt-nonfinite-unit-interval`
- Branch: `local/nonfinite-unit-interval-20260531`
- HEAD: run `git rev-parse HEAD` before citing a commit
- Author: `Rob Sneiderman <robbysneiderman@gmail.com>`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Machine-specific paths in a repository-committed document.

This memo contains several local filesystem paths that are specific to one developer's machine:

  • Lines 25-26: /private/tmp/formalslt-nonfinite-unit-interval and branch local/nonfinite-unit-interval-20260531
  • Lines 198, 572: /Users/robsneiderman/Desktop/AI4MATH/scripts/audit_public_writing.py

If this document is being committed to the public repository (as indicated by the PR context), these paths will not work for other developers or CI environments. Consider either:

  1. Using relative paths from the repository root for scripts
  2. Moving this to a separate local/private documentation location if it's truly a local-only memo
  3. Adding a note that paths should be adjusted for the user's environment

The memo header states this is a "local release-candidate memo" (line 4), which suggests it might be internal-only, but its presence in the PR indicates it will be public.

Also applies to: 198-204, 572-574

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/formalslt-v0.1-release-review-2026-06-01.md` around lines 25 - 28,
Replace all machine-specific absolute paths and local branch names in the memo
(e.g. the path string "/private/tmp/formalslt-nonfinite-unit-interval", the
branch identifier "local/nonfinite-unit-interval-20260531", and user-specific
script paths like
"/Users/robsneiderman/Desktop/AI4MATH/scripts/audit_public_writing.py") with
repository-relative paths or neutral placeholders; update references to scripts
to use a relative path from the repo root (or a configurable variable), or mark
the memo as explicitly local/private and remove these absolute paths, and ensure
the memo header (the "local release-candidate memo" phrasing) reflects whether
the file is intended for public commit so readers know to adjust paths for their
environment.

Comment on lines +572 to +574
python3 /Users/robsneiderman/Desktop/AI4MATH/scripts/audit_public_writing.py \
docs/formalslt-v0.1-technical-note.md \
docs/formalslt-v0.1-artifact-map-2026-06-01.md

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Machine-specific absolute path in public documentation.

Line 572 contains an absolute path /Users/robsneiderman/Desktop/AI4MATH/scripts/audit_public_writing.py that is specific to one developer's machine. Since this technical note is being committed to the repository, this path should either be:

  1. Made relative to a repository root (if the script is part of the repo)
  2. Replaced with a placeholder like <path-to-scripts>/audit_public_writing.py
  3. Documented as an example that users should adjust for their environment
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/formalslt-v0.1-technical-note.md` around lines 572 - 574, Replace the
machine-specific absolute path with a repo-relative path or a placeholder:
update the command that invokes audit_public_writing.py so it references the
script as ./scripts/audit_public_writing.py (or
<path-to-scripts>/audit_public_writing.py) and keep the output target as
docs/formalslt-v0.1-artifact-map-2026-06-01.md; alternatively add a brief
parenthetical note that users must adjust the path to their environment. Ensure
you edit the line containing audit_public_writing.py in the
docs/formalslt-v0.1-technical-note.md so it no longer contains
/Users/robsneiderman/... and instead uses the relative path or placeholder.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 10: The CONTRIBUTING.md currently gives mixed guidance about the default
branch: it allows `main` for public mirrors but later step still hardcodes
`release-candidate`; update the later instruction so it conditionally references
the default branch name instead of a hardcoded `release-candidate`. Locate the
step that instructs contributors to target or use `release-candidate` (search
for the literal "release-candidate") and change the wording to use a variable
phrasing like "the repository's default branch (e.g., `release-candidate` or
`main`)" or provide two conditional bullets, one for `main` and one for
`release-candidate`, so all references to branch target are consistent across
the document.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 89076b2b-d0c1-4e47-8542-0355fc6ac709

📥 Commits

Reviewing files that changed from the base of the PR and between 39c50f3 and 11872a3.

📒 Files selected for processing (4)
  • CONTRIBUTING.md
  • README.md
  • docs/next-lane.md
  • docs/public-release-checklist.md
💤 Files with no reviewable changes (1)
  • README.md
✅ Files skipped from review due to trivial changes (2)
  • docs/next-lane.md
  • docs/public-release-checklist.md

Comment thread CONTRIBUTING.md

- Open pull requests against the repository default branch. In the private
preview repo this is currently `release-candidate`; in a public showcase
preview repo this is currently `release-candidate`; in a public release

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Resolve branch-target guidance conflict in this file.

Line 10 says the default branch can be main in public mirrors, but Line 73 still hardcodes release-candidate. Please make the later step conditional too, so contributors get one consistent instruction path.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CONTRIBUTING.md` at line 10, The CONTRIBUTING.md currently gives mixed
guidance about the default branch: it allows `main` for public mirrors but later
step still hardcodes `release-candidate`; update the later instruction so it
conditionally references the default branch name instead of a hardcoded
`release-candidate`. Locate the step that instructs contributors to target or
use `release-candidate` (search for the literal "release-candidate") and change
the wording to use a variable phrasing like "the repository's default branch
(e.g., `release-candidate` or `main`)" or provide two conditional bullets, one
for `main` and one for `release-candidate`, so all references to branch target
are consistent across the document.

@Robby955 Robby955 merged commit 9cc6133 into main Jun 2, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant