Skip to content

Improve README and guide readability - #5044

Merged
Widthdom merged 1 commit into
mainfrom
docs/guides-readability
Aug 3, 2026
Merged

Improve README and guide readability#5044
Widthdom merged 1 commit into
mainfrom
docs/guides-readability

Conversation

@Widthdom

@Widthdom Widthdom commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Correct the Japanese README link so custom extraction points to the Japanese カスタム言語抽出 section.
  • Reorganize the User Guide's watch-mode and C# partial-grouping contracts into scannable tables, short paragraphs, and ordered rules in both languages.
  • Reorganize the Developer Guide's scoped refresh, FTS maintenance, and custom language extraction sections with matching English/Japanese structure.

Why

Several operational and implementation contracts had grown into very long paragraphs, making individual limits, lifecycle stages, and fallback behavior difficult to locate. The Japanese README also linked to the English developer-guide anchor.

Impact

Documentation only. Runtime behavior and public contracts are unchanged; the existing details are retained in a more navigable form.

Validation

  • dotnet test tests/CodeIndex.Tests/CodeIndex.Tests.csproj --framework net8.0 --filter 'FullyQualifiedName~DocumentationDriftTests|FullyQualifiedName~LicensePolicyTests' --no-restore --nologo -p:UseSharedCompilation=false (17 passed)
  • git diff --check

@Widthdom
Widthdom marked this pull request as ready for review August 3, 2026 22:02
@Widthdom
Widthdom merged commit c5e7455 into main Aug 3, 2026
1 check passed
@Widthdom
Widthdom deleted the docs/guides-readability branch August 3, 2026 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant