Repository navigation
docs: keep the how-to guides to their steps - #102
Merged
Merged
Conversation
TheMeinerLP
force-pushed
the
docs/correct-stale-facts
branch
from
October 10, 2026 18:44
936b5d6 to
5ec2b43
Compare
TheMeinerLP
force-pushed
the
docs/diataxis-how-to
branch
from
October 10, 2026 18:44
d712de1 to
e35d516
Compare
This was referenced Oct 10, 2026
TheMeinerLP
force-pushed
the
docs/correct-stale-facts
branch
from
October 10, 2026 19:28
5ec2b43 to
92ca658
Compare
TheMeinerLP
force-pushed
the
docs/diataxis-how-to
branch
from
October 10, 2026 19:31
e35d516 to
cfc56c9
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
Brings the ten How-to guides in
docs/how-to/and the first-world tutorial in line with Diátaxis. A How-tonow holds the goal, the prerequisites, numbered steps with one code block per step, a check, and short
"See also" links. Explanation and reference content that sat inside the steps moved to the explanation and
reference pages (or was already there and is now linked). The tutorial follows one path with a visible
result per step.
Stacked on #101 (
docs/correct-stale-facts), which is itself stacked on #99. Merge order: #99, #101, this PR.Page by page:
load-your-first-world-with-falco): one world layout (26.1+), pre-26.1 points to the How-to;imports moved to where they are used; shutdown hook fixed (see code corrections); the scheduler step has a
checkable result; the "What you did" section moved to the loader-choice explanation.
falco-bomand declares the modules; the rationalefor the BOM and the 404 note moved to Versioning and Supported versions.
explanation to the loader-choice page; TODO removed.
ON_DISK); rationale to World migration explanation; backup and floor details linked to Migration modes.linked to existing reference text;
4189explained as a sample value."one service serves every thread" moved to the concurrency page; the
BlockLightSourceexample completed.sky-light and batch explanations moved to the light engine page; measured figures already in Measured
results and linked; "roughly 100 KB" removed (unsourced).
API surface; events-versus-listener and shutdown rationale moved to the FalcoInstance explanation.
machine-record table stays as step 7; TODO removed.
Benchmarks and demo; the rest is already present elsewhere and is linked.
Removed from → moved to / already in
"Moved" means the text was added to the target page in its style. "Already in" means the target page already
has the same content (quoted by location).
how-to/load-an-anvil-world.mdreference/logging.md("Level isWARNwhen the error count is above zero")explanation/choosing-between-falco-and-the-built-in-loader.md("Both switches are opt-in")contributing/versioning-and-releases.md("Why consumers take the version from the BOM")reference/supported-versions.md("Artefact availability")contributing/build-setup.md("Credentials and a 401 during resolution")explanation/how-the-concurrency-design-works.md("One light service serves every thread")explanation/how-the-light-engine-works.md("Light across chunk borders")reference/api-surface-and-stability.md("Light engine types")explanation/how-the-light-engine-works.md("A change marks the 3×3")reference/measured-results.md("A replayed block change against lighting the chunks again")reference/measured-results.md("An independent earlier run gave 1.96× / 6.40× / 3.95×")explanation/scope-and-non-goals.md("The kept light is capped")reference/api-surface-and-stability.md("Entry points and signatures")DEFAULT_OPEN_REGION_LIMIT)explanation/how-world-migration-works.md("The two halves",IN_MEMORYparagraph)reference/migration-modes.md(Backup)reference/migration-modes.md("Missing engine", "Floors")explanation/how-world-migration-works.md("The rules, and where their numbers come from")reference/replaceable-policies.md("Resolution rules")reference/supported-versions.md("Chunk data version floor",dataVersionrow)reference/measured-results.md("Measurement environment", "What follows from the empty rows")explanation/what-a-measurement-here-means.md("What agreement would look like")reference/measured-results.md(same section and the ratio paragraph)reference/benchmark-catalogue.md("Size of the full run")contributing/benchmarks-and-demo.md("The CI benchmark workflow")explanation/what-a-measurement-here-means.md(1.35× against 1.13×)contributing/benchmarks-and-demo.md(same section)-prof gcanswers allocation claimsexplanation/what-the-benchmarks-establish.md(-prof gcparagraph)builddoes not run themcontributing/benchmarks-and-demo.md(full run,compileJmhJava)reference/api-surface-and-stability.md("Entry points and signatures")explanation/why-falco-instance-exists.md("Owning the loader and saving on shutdown")explanation/choosing-between-falcoinstance-and-instancecontainer.md("Before1.0.0this combination did not work at all")explanation/why-falco-instance-exists.md("The light engine on the instance")reference/api-surface-and-stability.md("Chunk lifecycle listener")explanation/why-falco-instance-exists.md("Shared instances", table); order paragraph addedreference/api-surface-and-stability.md("Read-only section access")Code corrections
new Thread(loader::close)did not compile, becauseFalcoAnvilLoader#close()throwsIOException. Replaced with a lambda that catches it;java.io.IOExceptionadded to the imports.worldRoot,dimension,ChunkMigrationModeandKeywere undefined or unimported; defined and imported.dimensionandPathdefined and imported; the two user-supplied policies marked as yours.Chunkimported;instanceand chunk coordinates marked as yours; theBlockLightSourceexamplenow has its imports (
net.onelitefeather.falco.light.BlockFace,BlockLightSource) and definesLAMPandSTONE,which were undefined.
instanceandopacityTablesmarked as yours.logbecamelogger,manageris defined,and the listener example no longer refers to an undefined collection.
(
FalcoAnvilLoaderconstructors andclose(),FalcoInstance.builderandregisterAndShutdownWith,ChunkLightService,ChunkLightState#update,LightPropagator#propagate,SectionOpacity.of,FalcoSharedInstanceconstructor,ChunkLifecycleListenerdefaults); no other mismatch was found.4189is not a constant in the code (it appears only as a sample value in thedemo and benchmark sources), so the example says so instead of naming a constant.
Removed TODO(maintainer) comments
These were HTML comments in the published text of the three pages below. Their content is listed here verbatim
so that it can become an issue.
docs/how-to/load-an-anvil-world.md:docs/how-to/reproduce-a-published-measurement.md:docs/how-to/keep-chunk-light-up-to-date-automatically.md:Not touched in this PR (outside the How-to pages and the tutorial, so not moved or edited): the other
TODO(maintainer)comments in explanation and reference pages, and the "roughly 100 KB" / "about 100 KB" wordingin
reference/measured-results.mdandexplanation/what-a-measurement-here-means.md, which may need the same decision.Types of changes
Checklist
https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT