docs: streamline bilingual README and consolidate detailed guides - #5343
Merged
Conversation
- Keep README focused on overview, quick start, and documentation links - Move detailed contracts and workflows into existing guides - Show badges only once at the top - Update documentation and license checks
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.
The bilingual README had grown to 763 lines of detailed query, audit, indexing, and status contracts before and around the introductory content. Reduce it to 151 lines focused on the product overview, quick start, capabilities, documentation links, contribution policy, and license.
Validation:
git diff --checkanddotnet run --project tools/CodeIndex.Changelog -- checkpassed.Documentation and bilingual changelog are included. Fragment:
changelog.d/unreleased/+readme-intro-cleanup.docs.md.