Repository navigation
docs: correct versions, counts and catalogue entries that had drifted from the code - #101
Merged
Merged
Conversation
3 tasks done
TheMeinerLP
force-pushed
the
docs/gitbook-diataxis
branch
from
October 10, 2026 18:44
d028336 to
85e8965
Compare
TheMeinerLP
force-pushed
the
docs/correct-stale-facts
branch
from
October 10, 2026 18:44
936b5d6 to
5ec2b43
Compare
This was referenced Oct 10, 2026
… from the code Corrections, each checked against the tree at this commit: - Current version 2.1.0 -> 3.0.0 on modules-and-coordinates and in the how-to and tutorial snippets (build.gradle.kts:7, .release-please-manifest.json). - BOM covers falco-anvil, falco-light, falco-instance only; falco-migration is published but not in the BOM (falco-bom/build.gradle.kts). - Minestom is compileOnly in anvil, light and instance; migration and bom declare none (*/build.gradle.kts). fastutil/flare are compileOnly in instance only. - Renovate rule in renovate.json matches README.md only; the docs say so. - ChunkDataException.Reason has seven constants; the five missing ones are added to the reason table (ChunkDataException.java:37-75). - Logging table: INFO for the pre-migration backup copy (FalcoAnvilLoader.java:2203). - SECTIONS_KEY is private; the link is replaced by plain text (FalcoAnvilLoader.java:94). - Minestom resolved version 2026.06.20-26.1.2 -> 2026.09.12-26.2 via mycelium-bom 1.8.7 (settings.gradle.kts, dependencyInsight offline). Historical measurement and source-citation statements are untouched. - Dependency pins in contributing docs and benchmark catalogue follow settings.gradle.kts: mycelium-bom 1.8.7, adventure 5.2.0, slf4j 2.0.20, fastutil 8.5.19, cyano 0.7.6, junit 6.1.3, archunit 1.5.1. - Gradle wrapper 9.6.1 -> 9.8.1 (gradle-wrapper.properties). - Module count seven -> eight (settings.gradle.kts); falco-migration listed as published (build.gradle.kts publishedModules). - Workflow pins @v2.4.0 replaced by a link to the pinned file in .github/workflows (currently v2.9.0). - Benchmark catalogue: nine classes that had no entry added (AreaPassStage, ChunkComparison, ChunkLookup, ChunkResendCost, GeneratorCommit, LazySection, PaletteIndirectGet, SectionAllocation, SetBlockContention) from their @PARAM and @benchmark declarations. - Heap statement: three classes set no heap flags, not two (AreaVsPerChunk, IncrementalVsFull, ChunkLookup which has no @fork). Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
Falco 3.0.1 (build.gradle.kts, .release-please-manifest.json), mycelium-bom 1.8.9 (settings.gradle.kts) and the Minestom it resolves to, 2026.10.07-26.2 (dependencyInsight on falco-anvil compileClasspath). Historical measurement statements keep their versions. Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
TheMeinerLP
force-pushed
the
docs/correct-stale-facts
branch
from
October 10, 2026 19:28
5ec2b43 to
92ca658
Compare
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.
Proposed changes
Stacked on #99 (
docs/gitbook-diataxis), so the diff shows only the correction commit. Once #99 merges, retarget this PR tomain.This PR corrects facts in
docs/(exceptdocs/superpowers/) that had drifted from the code. No page was moved, restructured or restyled. Each correction below is checked against the tree at this commit; where a fact could not be checked, it is left unchanged and listed under Open.Corrections (fact, then evidence)
2.1.0->3.0.0inreference/modules-and-coordinates.md(5 rows),how-to/add-falco-to-your-build.md,tutorials/load-your-first-world-with-falco.md. Evidence:build.gradle.kts:7(version = "3.0.0"),.release-please-manifest.json.falco-migrationis published but not in the BOM, so the how-to now gives it an explicit version. Evidence:falco-bom/build.gradle.kts:5-7;falco-migrationis inpublishedModules(build.gradle.kts:66).compileOnly: present infalco-anvil,falco-light,falco-instanceonly.falco-migrationandfalco-bomdeclare none. fastutil and flare-fastutil arecompileOnlyinfalco-instanceonly. Evidence: thefalco-*/build.gradle.ktsfiles.renovate.jsonmatchesREADME.mdonly, so the docs are not updated by it. The page now says so instead of "cannot reach". Evidence:renovate.jsonmanagerFilePatterns.ChunkDataException.Reasonhas seven constants, not six. The five missing ones are added to the reason table with their Javadoc meanings. Evidence:falco-anvil/.../ChunkDataException.java:37-75.RegionFormatException.Reasonhas five and is still not listed (noted on the page).INFOlineCopied {} to {} before migrating its chunks on diskis added to the level table. Evidence:falco-anvil/.../FalcoAnvilLoader.java:2203.SECTIONS_KEYlink removed: the constant isprivate static final, so the link pointed at nothing public. Name and value stay as text. Evidence:FalcoAnvilLoader.java:94.2026.06.20-26.1.2->2026.09.12-26.2in the present-tense build statements:reference/supported-versions.md,contributing/README.md,contributing/dependency-management.md,contributing/documentation-conventions.md,reference/benchmark-catalogue.md, the tutorial snippet. Evidence:settings.gradle.kts(bom=1.8.7), and./gradlew --offline :falco-anvil:dependencyInsight --dependency net.minestom:minestom --configuration compileClasspathresolvesnet.minestom:minestom:2026.09.12-26.2 (by constraint)viamycelium-bom:1.8.7.settings.gradle.kts: mycelium-bom1.8.7, adventure-bom5.2.0, slf4j2.0.20, fastutil8.5.19, Cyano0.7.6, JUnit6.1.3(verified offline), ArchUnit1.5.1.9.6.1->9.8.1incontributing/build-setup.mdandcontributing/README.md. Evidence:gradle/wrapper/gradle-wrapper.properties.seven->eight, andfalco-migrationis listed as published. Evidence:settings.gradle.kts(eightincludes), the eightfalco-*/build.gradle.ktsfiles,build.gradle.kts:66.@v2.4.0are replaced by a link to the file that pins the version (.github/workflows/release-please.ymlforgradle-publish,.github/workflows/build-pr.ymlforgradle-build-pr). The pinned value there isv2.9.0. The pages no longer carry a number that goes stale.@Paramvalues taken from the code and "What it answers" taken from each class Javadoc:AreaPassStageBenchmark(light table), and an Instance table forChunkComparisonBenchmark,ChunkLookupBenchmark,ChunkResendCostBenchmark,GeneratorCommitBenchmark,LazySectionBenchmark,PaletteIndirectGetBenchmark,SectionAllocationBenchmark(no@Param, shown as "-"),SetBlockContentionBenchmark. All 25@Benchmarkclasses infalco-benchmarks/src/jmhnow have an entry.AreaVsPerChunkBenchmark,IncrementalVsFullBenchmark, andChunkLookupBenchmark, which has no@Forkannotation at all. Evidence:grep -rn "@Fork" falco-benchmarks/src/jmh. The same correction is applied to the "One heap gap" paragraph ofreference/measured-results.md.Deliberately not changed
reference/measured-results.md,how-to/reproduce-a-published-measurement.md: these state the Minestom and JMH setup the published numbers were measured with. That is history, not the current build.project-record/project-status.md:413("the 2.1.0 release"): historical.2026.06.20-26.1.2" (see Open).Open (not changed, needs its own pass)
2026.06.20-26.1.2source lines, and some statemycelium-bom1.7.2 as the current pin in present tense (for exampleexplanation/why-a-custom-light-engine.md:21,explanation/why-falco-instance-exists.md:30,explanation/why-a-second-anvil-loader.md:18,explanation/what-a-measurement-here-means.md:542,871,explanation/how-the-concurrency-design-works.md:13,explanation/what-the-benchmarks-establish.md:149,explanation/choosing-between-falco-and-the-built-in-loader.md:8,13,explanation/comparing-the-light-engine-with-minestoms.md:325,explanation/how-the-light-engine-works.md:206). Line numbers have to be re-read against2026.09.12-26.2before these can move. Not done here.2026.09.12-26.2declares adventure-nbt5.1.1and fastutil8.5.18(as2026.06.20did) was not re-checked.dependency-management.mdnow says so explicitly. The Minestom POM is not in the local Gradle cache.project-record/project-status.md: the entries "Resolved in perf(light): keep the opacity tables of a chunk with its light #34" (line 799) and "Resolved in fix(anvil): refuse a full chunk that carries no sections #49" (line 901) sit under## Open. Reported only, for a follow-up PR.CONTRIBUTING.md(repo root, outsidedocs/): historical sentence aboutmycelium-bom:1.7.2"up to 2.1.0". Left as it is.benchmark-catalogue.md"mycelium-bom ... covers adventure, minestom, cyano, junit and mockito only": checked against the cachedmycelium-bom1.8.5 POM (adventure-text-minimessage,cyano,junit-bom,minestom,mockito-*); the 1.8.7 POM itself was not read.Checks
check.pywithROOTtaken from argv, since the original hard-codes another worktree):scanned 62 files, 855 relative links/anchors,PROBLEMS: none, exit 0.2\.1\.0|9\.6\.1|v2\.4\.0indocs/(excluding superpowers): onlyproject-record/project-status.md:413(historical)../gradlew buildwas not run.Types of changes
Checklist
./gradlew buildis green locally (not run: docs-only change)Stacked on #99.
https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT