Improve README readability - #5043
Merged
Merged
Conversation
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
Why
The README had accumulated detailed command and contract prose that duplicated the dedicated guides. This made the project overview difficult to scan and blurred the boundary between introductory and reference documentation.
Impact
The README is reduced from 1,037 lines to 391 lines while preserving its English and Japanese sections, installation entry points, representative commands, supported surfaces, documentation map, status field index, release verification, and license guidance.
Detailed behavior remains available through links to
USER_GUIDE.mdandDEVELOPER_GUIDE.md.Validation
dotnet test tests/CodeIndex.Tests/CodeIndex.Tests.csproj --framework net8.0 --filter 'FullyQualifiedName~DocumentationDriftTests|FullyQualifiedName~LicensePolicyTests' --no-restore --nologo— 17 passedgit diff --checkcdidx outline README.md --json --kind heading --limit 100 --max-json-bytes 32768— 26 bilingual headings recognizedcdidx status --check --json— workspace matched and readiness checks passedDocumentation and changelog
README.mdandUSER_GUIDE.mdFollow-ups
None.