Skip to content

docs: move the documentation from the wiki into a gitbook space - #99

Merged
TheMeinerLP merged 3 commits into
mainfrom
docs/gitbook-diataxis
Oct 10, 2026
Merged

TheMeinerLP merged 3 commits into
mainfrom
docs/gitbook-diataxis

Conversation

@TheMeinerLP

Copy link
Copy Markdown
Contributor

Proposed changes

The Falco documentation moves from the GitHub wiki into docs/, which is now a GitBook space. .gitbook.yaml sets the root to ./docs/, and docs/SUMMARY.md is 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:

  • "wiki" meaning the Falco wiki now reads "documentation" (in docs/, README.md, CONTRIBUTING.md, falco-demo/README.md and the issue templates). Links to external wikis (Minecraft Wiki, Caffeine, Eclipse, OpenJDK, DeepWiki) are unchanged.
  • The pages are grouped by Diátaxis quadrant, with a landing page for each group that has more than one page. Research notes and the status page sit in a new "Project record" group, outside the quadrants.
  • Relative links inside docs/ are rewritten for the new locations. Links that leave docs/, or point at a file that is not a page or image, are absolute GitHub URLs.
  • README.md, CONTRIBUTING.md, falco-demo/README.md and the issue templates point at the new pages. The README badge reads docs-gitbook.

Where the pages went

Quadrant / group Pages Location
Tutorial 1 docs/tutorials/
How-to guides 10 docs/how-to/ (landing: how-to/README.md)
Reference 9 docs/reference/ (landing: reference/README.md)
Explanation 15 docs/explanation/ (landing: explanation/README.md)
Project record status page + 6 research notes docs/project-record/ (landing: project-record/README.md), moved from docs/contributing/project-status.md and docs/explanation/research/
Contributing 9 + landing, benchmark baselines docs/contributing/, docs/benchmarks/README.md (listed under Contributing)

Assets stay where they were: docs/charts/ (SVGs and generate.mjs) and docs/benchmarks/full-run.sh.

Wiki links that had no target

Nine wiki URLs in README.md and CONTRIBUTING.md pointed 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:

  • paragraphs that mix quadrants,
  • stale facts, e.g. the supported version that still reads 2.1.0 where the current release is 3.0.0,
  • the BOM is documented without falco-migration,
  • the number of Reason constants,
  • the benchmark catalogue,
  • the workflow action pins.

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

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Performance change (behaviour unchanged, cost changed)
  • Documentation Update (if none of the other choices apply)

Checklist

  • The title of this pull request is a Conventional Commit.
  • I have read the CONTRIBUTING.md
  • Tests, Javadoc and ./gradlew build: not applicable, this change touches only documentation and no Java or Gradle file.
  • I have added necessary documentation (if appropriate)

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 in SUMMARY.md, and no SUMMARY.md entry points at a missing file.

https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT

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
TheMeinerLP force-pushed the docs/gitbook-diataxis branch from d028336 to 85e8965 Compare October 10, 2026 18:44
@TheMeinerLP
TheMeinerLP merged commit e222cb2 into main Oct 10, 2026
4 checks passed
@TheMeinerLP
TheMeinerLP deleted the docs/gitbook-diataxis branch October 10, 2026 19:27
@TheMeinerLP
TheMeinerLP restored the docs/gitbook-diataxis branch October 10, 2026 19:28
@TheMeinerLP
TheMeinerLP deleted the docs/gitbook-diataxis branch October 10, 2026 19:28
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