docs: humanize mkdocs pages - #193
Open
matejsemancik wants to merge 1 commit into
Open
Conversation
Remove AI writing tells across the documentation site: - Drop all em/en dashes; use colons, commas, or restructured sentences instead (and a check mark for the unsupported-target marker in the module table) - Convert title-case headings to sentence case, keeping code identifiers and proper nouns intact - Replace promotional, signposting, and aphorism phrasing in index.md and architecture/overview.md with plain statements - Align the "Advanced navigation" nav label in mkdocs.yml Anchor slugs are preserved, so existing in-page links still resolve, and `mkdocs build` runs clean. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
A humanization pass over the MkDocs documentation site to remove AI writing tells, while keeping all technical content, code blocks, and tables intact.
Changes
—"not supported" marker in the module-selection table is now✗(mirroring✓), and the--separator inlint.mdis gone.BaseComponent,NavigationActions,FlowUseCase, …) and proper nouns (Compose, Koin, KSP, DataBinding, Jetpack Navigation) keep their casing. Dashed H1s use a parenthetical form, e.g.Components — KMP→Components (KMP).index.mdandarchitecture/overview.md(e.g. "gives you a solid, testable foundation" softened; "Two Paths, One Philosophy" → "Two paths, one approach"; "Dive In" → "Related pages").mkdocs.yml: nav labelNavigation - Advanced→Advanced navigationto match the new H1.Verification
grep '—\|–'over the markdown returns nothing.→,↔) and check marks (✓) in diagrams/tables are preserved.#parent-component,#kmp-alternatives) still resolve.mkdocs servebuilds the site with no warnings.🤖 Generated with Claude Code