docs: fix heading case and terminology consistency#488
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
Summary
Apply the repo's documented style standards (Title Case headings, "sync" over "synchronized") in a handful of pages that deviated from the surrounding convention.
Changes
sync/advanced/sharded-databases.mdx— 5 numbered scenario headingsclient-sdks/advanced/local-only-usage.mdx— 2 numbered headings (a sibling heading in the same file was already Title Case)client-sdks/advanced/unit-testing.mdx— replace a sentence-form H4 (#### If you have trouble with loading the extension, confirm the following) with a Title Case H3 (### Troubleshooting Extension Loading) plus a lead-in sentence, matching the H3 level of its sibling sections.synchronized→synced/in sync):client-sdks/advanced/attachments.mdx(2 occurrences)client-sdks/advanced/sequential-id-mapping.mdx(1 occurrence)Context
AGENTS.mdand.claude/CLAUDE.mdspecify Title Case headings and "sync" over "synchronization". Skipped cases that looked intentional or risked changing technical/legal meaning:configuration/source-db/setup.mdx— the sentence-case numbered headings are repeated identically as a template across 8+ Postgres hosting provider blocks, so they're internally consistent.maintenance-ops/implementing-schema-changes.mdx—#### DROP and re-CREATE tablematches sibling SQL-command headings (#### DROP table,#### CREATE table).resources/hipaa.mdxandresources/local-first-software.mdx— "synchronize/synchronization" appears in legal/principle wording.