Improve docs and metadata#68
Merged
Merged
Conversation
Add YAML frontmatter (title + description) to all documentation pages so search engines generate accurate per-page snippets rather than falling back to the global site description. Also update site_name to "xml2db" for cleaner browser tab titles, add explicit nav labels in mkdocs.yml, and fix several grammar errors (a/an before XML/XSD, "Hash are" → "Hashes are", "is call" → "is called", "corrsponding" typo, extra space). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013pzr3Q9XGumr7WVfHGGtXV
Rewrite wordy or awkward sentences across all four main documentation
pages — especially the home page. Changes include splitting overly long
sentences, removing filler phrases ("in order to", "if need be", "the
simplest solution will be to"), fixing subject-verb agreement ("follow"
→ "follows", "Columns corresponds" → "Columns correspond"), correcting
a few remaining article errors ("a XML" → "an XML"), and removing double
spaces left by earlier edits.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013pzr3Q9XGumr7WVfHGGtXV
Swap all em-dash asides introduced in the previous rewrite for commas, colons, full stops, or parentheses as appropriate. Covers all five edited files plus the api/overview.md multiprocessing section. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013pzr3Q9XGumr7WVfHGGtXV
ETL is searched far more often than ELT and is what many teams call this pattern regardless of load order. Mentioning both is accurate and improves discoverability without keyword stuffing. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013pzr3Q9XGumr7WVfHGGtXV
- Fix ngroup type annotation (Union[int, None] → Union[str, None]) - Add missing name_chain and has_suffix to DataModelColumn Args docstring; clarify ngroup and model_config descriptions - Fix add_relation_n docstring: "1-1" → "1-n" - Replace stale save_db references with insert_into_target_tables in get_merge_temp_records_statements docstrings - Fix >>> continuation lines to ... in DataModel doctest example - Remove empty Examples: section from extract_from_database - Fix "indentin" typo in XMLConverter.to_xml - Fix metadata_columns default: None → [] in configuring.md - Add base64Binary and decimal to join-eligible types list - Fix extra_args example: wrap bare Index in a list - Fix choice_transform label: "True (default)" → "True (force on)" - Correct elevation rules: 4-column threshold, columns-only count, and missing "no n-n parents" constraint Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
martinv13
changed the title
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
2 participants
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.
No description provided.