docs: drop case-duplicate index.md — keep canonical INDEX.md (macOS checkout fix) - #8
Open
gustavorps wants to merge 1 commit into
Open
docs: drop case-duplicate index.md — keep canonical INDEX.md (macOS checkout fix)#8gustavorps wants to merge 1 commit into
gustavorps wants to merge 1 commit into
Conversation
The v12 docs mirror refresh (966bdf6) tracked both INDEX.md and index.md with different blobs; on case-insensitive filesystems the pair can never be checked out cleanly. Keep the canonical INDEX.md (full nav index).
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.
Problem
docs/terminusdb/tracks two files differing only in case:INDEX.md— the canonical navigation index (293 lines, links every mirror file)index.md— the mirrored docs landing page (added by the 2026-07-08 mirror refresh, commit966bdf6)On case-insensitive filesystems (macOS APFS default, Windows NTFS) the two git entries share the same disk file. Since the tracked blobs have different content, one of the two entries always shows as modified —
git statusis permanently dirty for every contributor on macOS, and no checkout/reset can reconcile them. This breaks the developer experience and anygit status-based checks in local workflows.Fix
Remove
docs/terminusdb/index.md(the lowercase entry), keeping the canonicalINDEX.md.docs/terminusdb/README.mdre-copies it from upstreamsrc/app/docs/page.md.docs/terminusdb/index.md(verified), so no links break.index-your-data.mdetc. are unaffected.Notes
README.mdwill regenerate the landing page asindex.mdagain on the next mirror refresh; that is acceptable — the refresh procedure may adopt a case-safe name (e.g.landing.md) in a follow-up.