Repository navigation
feat: render source-owned documentation availability - #372
Open
brendanclement wants to merge 2 commits into
Open
brendanclement wants to merge 2 commits into
brendanclement wants to merge 2 commits into
Conversation
A page in any root can declare in its frontmatter whether LanceDB OSS and
LanceDB Enterprise have what it describes. A new annotate stage, after
overlays are merged, reads that from the page the site publishes and
renders it into the page: a label of badges and the page's summary above
its content, a sidebar tag when one offering only has it, and a row in the
table that replaces a {/* availability-comparison */} line, in navigation
order. Nothing else is kept in this repository: the facts stay beside the
pages they describe.
Malformed declarations, a page's own badge above its label, an explicit
tag on a declaring page and misplaced comparison lines stop the build. An
overlay that drops its reference page's declaration is reported. Pages
that declare nothing are copied unchanged, so today's sources assemble to
the same bytes.
The label went after a page's import and export blocks, found by taking the first blank line as their end. MDX JavaScript may contain blank lines, so a multiline import or export with one got the label inside it and no longer compiled. The label now goes directly after the frontmatter: MDX allows imports and exports after content, and the rendered pages are unchanged. A hand-set tag was refused only when the declaration produced a tag of its own, so a page declaring both offerings kept a stale one. Every declaring page now has to leave `tag` to its declaration. The new tests cover both, and compile the labelled pages with Mint's MDX compiler when MDX_COMPILER points at it.
brendanclement
marked this pull request as ready for review
October 9, 2026 03:20
This branch has not been deployed
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.
Generate availability labels, sidebar tags and the offerings comparison table from metadata on each source page. This keeps availability information alongside the documentation it describes.