Repository navigation
docs: slim the readme down and point at the gitbook space - #105
Merged
Merged
Conversation
The README repeated most of the gitbook space: module descriptions with claims, a benchmark section with provenance lines and tables, and an API tour. It now keeps the badges, a short description, a feature list linking to the gitbook pages, the quick start and links into the four documentation parts. Content that existed only in the README moved into the gitbook space: - how-to/keep-chunk-light: scheduler builder settings, markChanged/markDirty, the ChunkLightListener route on an InstanceContainer - how-to/load-an-anvil-world: builder settings, diagnostics, regionDirectory, legacyLayout, openRegionCount - how-to/use-falcoinstance: generator example and palette copy semantics - reference/measured-results: the Minestom version and the 26.2 caveat - explanation/why-falco-instance-exists: the pre-1.0.0 superclass constraint Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
Four modules are published (falco-anvil, falco-light, falco-instance, falco-migration); the BOM covers three of them. The experimental note now says "all published modules", and the README lists world migration. Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
Nested list items under a README were turned into deeper URLs on the published space: the research index is only served at /falco/project-record/project-record/research, and nothing resolves at /falco/project-record/research. GitBook's Git Sync guidance asks for the README as a top-level sibling with flat bullets under group headings, so the project record section now follows that shape. Only the section's own URLs change; each page also resolves at its file-path URL. Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
Each group in SUMMARY.md now lists its folder README first and the pages as sibling bullets below it, following GitBook's guidance for summaries. Nested bullets under a README produced doubled navigation URLs such as reference/reference/... and contributing/contributing/benchmarks; the plain file-path URLs that external links use already resolve. Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
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
1 participant
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
The documentation now lives on the GitBook space at https://docs.onelitefeather.net/falco, and the GitHub wiki is gone.
This PR points readers at that space and cuts the README down to a front door for it:
CONTRIBUTING.md,falco-demo/README.md, the issue forms and the pull request template now point at the matching GitBook page. Every target was checked withcurland returned 200. Links insidedocs/are unchanged.docs/or was moved there in the second commit. The quick start keeps the release-please-marked dependency block unchanged and gets the tutorial's runnable example.docs/: scheduler and builder settings, the Anvil builder and diagnostics, the generator example, the Minestom version caveat for the measured results, and the pre-1.0.0 superclass constraint.Types of changes
Checklist
https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
After merge (not verified yet)
GitBook syncs
mainonly after the merge, so these URLs cannot be checked from this branch. Run them once the space has synced; the status codes are the expected results.curl -sS -o /dev/null -w '%{http_code}' -L https://docs.onelitefeather.net/falco/how-toexpected 200 (today 404; live only ashow-to-guides/how-to)curl … /falco/project-record/researchexpected 200 (today 404; live only asproject-record/project-record/research)curl … /falco/benchmarksexpected 200 (today 404; live only ascontributing/contributing/benchmarks)/falco/how-to/add-falco-to-your-build,/falco/reference/measured-results,/falco/contributing/benchmarks-and-demoredirectsentry in.gitbook.yamlonly after confirming the target URL.