Repository navigation
docs: move the documentation from the wiki into a gitbook space - #99
Merged
Merged
Conversation
This was referenced Oct 10, 2026
Copies the Falco wiki (origin/master 04f9ace4) into docs/ as a GitBook space organised by Diátaxis: tutorials, how-to, reference, explanation (with research notes) and contributing. Wiki-internal links are rewritten to relative paths; chart images point at docs/charts/. The wiki sidebar and footer are not copied; SUMMARY.md takes their order. Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
The repository README, CONTRIBUTING.md, the pull request template and the benchmarks README linked into the GitHub wiki. Those links now point at the matching pages under docs/. Links that named wiki pages which no longer exist map to the closest current page; the Installation anchor #building-from-source is dropped because the target page has no such heading. Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
Structural follow-up to the move of the wiki into docs/: - Replace "wiki" wording that meant the Falco wiki with "documentation" in docs/, README.md, CONTRIBUTING.md, falco-demo/README.md and the issue templates. External wikis (Minecraft Wiki, etc.) are unchanged. - Point GitHub wiki URLs at the new pages as absolute blob URLs, and make the README badge read "docs-gitbook". - Group research notes and the status page as a "Project record": move docs/explanation/research to docs/project-record/research and docs/contributing/project-status.md to docs/project-record/, with all relative links rewritten. - Add landing pages for how-to guides, reference, explanation and the project record, and list them as parents in SUMMARY.md. - Add the benchmark baselines page to the contributing group. - Turn relative links that leave docs/ or point at non-page files into absolute GitHub URLs. Page content is unchanged; only wording and links were touched. Claude-Session: https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT
TheMeinerLP
force-pushed
the
docs/gitbook-diataxis
branch
from
October 10, 2026 18:44
d028336 to
85e8965
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
The Falco documentation moves from the GitHub wiki into
docs/, which is now a GitBook space..gitbook.yamlsets the root to./docs/, anddocs/SUMMARY.mdis the table of contents. The wiki is switched off after this merges.The page content is carried over unchanged from the wiki (source: wiki commit
04f9ace4). This PR only changes structure and wording:docs/,README.md,CONTRIBUTING.md,falco-demo/README.mdand the issue templates). Links to external wikis (Minecraft Wiki, Caffeine, Eclipse, OpenJDK, DeepWiki) are unchanged.docs/are rewritten for the new locations. Links that leavedocs/, or point at a file that is not a page or image, are absolute GitHub URLs.README.md,CONTRIBUTING.md,falco-demo/README.mdand the issue templates point at the new pages. The README badge readsdocs-gitbook.Where the pages went
docs/tutorials/docs/how-to/(landing:how-to/README.md)docs/reference/(landing:reference/README.md)docs/explanation/(landing:explanation/README.md)docs/project-record/(landing:project-record/README.md), moved fromdocs/contributing/project-status.mdanddocs/explanation/research/docs/contributing/,docs/benchmarks/README.md(listed under Contributing)Assets stay where they were:
docs/charts/(SVGs andgenerate.mjs) anddocs/benchmarks/full-run.sh.Wiki links that had no target
Nine wiki URLs in
README.mdandCONTRIBUTING.mdpointed at pages the wiki never had under those names: Installation (and#building-from-source), Benchmarking, Rationale, Rationale: Instances and Chunks, Rationale: Measurement, Light Engine, Anvil Chunk Loader, Instances and Chunks, and Measured Results. Each was mapped to the nearest new page, and the anchors that could be matched were kept.Not in this PR
Content review (Diátaxis cleanup and stale facts) comes in follow-up PRs. Known items:
falco-migration,Reasonconstants,To check in the real space
GitBook rendering is not verified by the link checker. Please check after the preview is up:
<details>,<sub>,<img>, Mermaid blocks, and anchors that contain special characters.Types of changes
Checklist
./gradlew build: not applicable, this change touches only documentation and no Java or Gradle file.Further comments
Only
docs/,README.md,CONTRIBUTING.md,falco-demo/README.md, and the issue templates changed. Links were checked with a script: all relative links and anchors resolve, every page under the quadrant and contributing folders is inSUMMARY.md, and noSUMMARY.mdentry points at a missing file.https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT