forked from
anil.recoil.org/monopam-myspace
My aggregated monorepo of OCaml code, automaintained
Mark sherlodoc Phase 1 shipped and record Phase 2 plan
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
+17
-1
+17
-1
docs/plans/2026-04-15-sherlodoc-mld-indexing.md
+17
-1
docs/plans/2026-04-15-sherlodoc-mld-indexing.md
···
1
1
# Sherlodoc mld Page-Prose Indexing
2
2
3
-
**Status:** Planned
3
+
**Status:** Phase 1 shipped (2026-04-15); Phase 2 deferred
4
4
**Date:** 2026-04-15
5
5
6
6
## Problem
···
74
74
Section < Subsection) so page-level hits float up.
75
75
76
76
## Sequence
77
+
78
+
### Phase 1 — one-entry-per-page (SHIPPED)
79
+
80
+
Trivial change: remove `Doc` and `Page _` from the
81
+
`is_pure_documentation` filter in
82
+
`odoc/sherlodoc/index/load_doc.ml:220-223`. The inner `register_entry`
83
+
already handles `Doc`-kind entries correctly (skips
84
+
`register_full_name` and `register_kind` for them), so page body text
85
+
flows straight into `register_doc`'s tokeniser. One result per page,
86
+
matched by any word in the body. No new AST variants, no URL work.
87
+
88
+
Verified via a standalone cram-style test:
89
+
`sherlodoc index` + `sherlodoc search "parseff"` returns the indexed
90
+
`.mld` page hit, and a nonsense query returns `[No results]`.
91
+
92
+
### Phase 2 — per-heading entries (DEFERRED)
77
93
78
94
1. Add `Heading` kind in both `entry.ml`s.
79
95
2. Recurse in `skeleton.ml`; emit heading entries.