Skip to content

docs(format): add FM-Index to scalar index navigation - #8395

Merged
westonpace merged 1 commit into
lance-format:mainfrom
jackylee-ch:docs/fmindex-nav
Aug 7, 2026
Merged

docs(format): add FM-Index to scalar index navigation#8395
westonpace merged 1 commit into
lance-format:mainfrom
jackylee-ch:docs/fmindex-nav

Conversation

@jackylee-ch

Copy link
Copy Markdown
Contributor

fmindex.md has been in the tree since #7123 but was never added to the
scalar index nav, so the page is published yet unreachable from the sidebar:
lance.org/format/index/scalar/fmindex/ returns 200, while the BTree page
lists only its seven other siblings.

Placed between N-gram and RTree, matching the file's position in the
directory listing.

Documentation only; no format change.

`fmindex.md` has been in the tree since lance-format#7123 but was never added to the
nav, so the page is published yet unreachable from the sidebar.
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Important

This PR touches the Lance format specification.

Substantive changes to the format specification — the .proto definitions
and the spec docs under docs/src/format/ — require a PMC vote before merge.
Minor edits such as typo fixes, wording, or formatting are excluded; use your
judgment.

If this is a meaningful format change:

  • Start a vote following the Lance community voting process.
    Format specification modifications need 3 binding +1 votes (excluding the
    proposer), held on GitHub Discussions, with a minimum voting period of 1 week.
  • Once the vote passes, link the completed vote in this PR. It should not be
    merged until the vote is linked.

@github-actions github-actions Bot added A-format On-disk format: protos and format spec docs documentation Improvements or additions to documentation labels Aug 7, 2026

@lance-gatekeeper lance-gatekeeper Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gate recommendation: approve.

This restores sidebar discoverability for the existing FM-Index format page without changing the format contract.

@westonpace westonpace left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to go ahead and say this is not a change to the spec. This is just restoring docs that were missing.

@westonpace
westonpace merged commit 2bcaa9c into lance-format:main Aug 7, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-format On-disk format: protos and format spec docs documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants