Document the columnar output formats; fix the mkdocs nav - #335
Merged
Merged
Conversation
The Parquet and DuckDB formats shipped undocumented, and three passages in index.md were left saying the opposite of what the CLI now does: - the -f format list omitted parquet and duckdb - the -O extension list omitted .parquet and .duckdb - the architecture section told readers that output was "intentionally limited to text-based representations" and to reach for a downstream tool for exactly the thing map-data now does natively Adds a Columnar Output section covering nested STRUCT columns, --table-name, and accumulating several runs into one .duckdb file. Every command and claim here was run against tests/input/examples/tabular first. Also states plainly that the SQL backend drops expr, value, case(), unit conversion and value mappings *silently*, since a spec using them compiles to SQL that quietly omits those slots. The nav used mappings where mkdocs wants lists, which made `mkdocs build --strict` abort on two config warnings before reaching any content checks.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the project documentation to accurately reflect the currently shipped CLI capabilities for columnar outputs (Parquet and DuckDB) and fixes the MkDocs navigation so strict builds don’t fail due to nav schema warnings.
Changes:
- Corrects
map-dataoutput format documentation to includeparquetandduckdb, including extension-based inference and-Oadditional outputs. - Adds a “Columnar Output” section documenting nested
STRUCTpreservation and DuckDB--table-name/ multi-run accumulation behavior. - Fixes
mkdocs.ymlnav structure by convertingExamplesandSpecificationentries from mappings to lists (MkDocs-compatible).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| mkdocs.yml | Fixes nav structure to satisfy MkDocs’ expected list syntax and avoid strict build warnings. |
| docs/index.md | Updates CLI docs to include Parquet/DuckDB output formats and documents columnar output behavior and SQL backend caveats. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Light docs pass before the release, focused on where the docs are wrong rather than merely thin.
Three passages contradicted the shipped CLI
Parquet and DuckDB (#333) landed undocumented, which left
index.mdactively misleading in three places:-f/--output-formatlist omittedparquetandduckdb.-Oextension list omitted.parquetand.duckdb.Added a Columnar Output section covering the nested-
STRUCTbehaviour,--table-name, and accumulating several runs into one.duckdbfile.Everything here was verified, not transcribed
I ran each documented command against
tests/input/examples/tabularrather than paraphrasing #333's description:.duckdbpath with different--table-namevalues →SHOW TABLESreturns['person', 'person_csv'], confirming accumulationSTRUCTclaim is asserted by existing tests (STRUCT(value_decimal DOUBLE, unit VARCHAR)), so I cited behaviour that's already pinnedduckdbwas already required by the join engineSQL backend caveat sharpened
It was described as "experimental" with "a limited subset". The word that was missing is silently:
expr,value,case(), unit conversion and value mappings are dropped without raising, so a spec using any of them compiles to SQL that quietly omits those slots. That's a correctness trap, not a feature gap, and it now says so.mkdocs nav
The
ExamplesandSpecificationsections used YAML mappings where mkdocs wants lists, somkdocs build --strictaborted on two config warnings before reaching any content checks. Pre-existing on main; fixed here since it's cheap and it makes strict builds usable.Not fixed here
With the nav corrected, strict mode surfaces 21 broken image links in
docs/schema/overview.md— references toimg/Mapping Between LinkML Schemas*.pngthat have never existed in the repo. That file is generated bymake gendoc, so the fix belongs in the generator or the source schema, not a docs edit. Filing separately. CI runsmkdocs gh-deploywithout--strict, so this isn't newly broken — just newly visible.Normal
mkdocs buildsucceeds, as before.