You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR improves documentation detection and scoring by introducing a tree-based discovery approach instead of relying on a single hardcoded README path.
Added tree-based documentation discovery using GraphQL repository trees
Added support for README variants with different casing and extensions (README.md, readme.md, README.rst, etc.)
Added support for documentation files located in docs/, doc/, and documentation/ directories
Implemented two-phase retrieval to fetch documentation content only after documentation files are detected
Added priority-based matching to select the most appropriate documentation file
Integrated updated documentation scoring into repository evaluation logic
Added consistent documentation detection behavior across both Python and TypeScript implementations
Added comprehensive test coverage with Vitest and Python unittest suites
How Has This Been Tested?
Added 12 Vitest test cases
Added 7 Python unittest test cases
Verified all 19 tests pass successfully
Verified TypeScript build completes successfully
Manually validated detection of README variants and documentation files in standard documentation directories
Checklist
☑️ My code follows the existing code style of the project
☑️ I have performed a self-review of my own code
☑️ I have added/updated tests where necessary
☑️ My changes do not introduce any new warnings or errors
☑️ I have linked the related issue
Hi @Sushma-1706 ,
Just following up on this issue. I wanted to check if there are any changes or improvements needed from my side. Please let me know if there's anything I should update or address.
Thank you!
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
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.
This PR improves documentation detection and scoring by introducing a tree-based discovery approach instead of relying on a single hardcoded README path.
Closes #7
Type of Change
☑️ Enhancement
☑️ Backend
☑️ Documentation Analysis
☑️ Testing
Changes Made
README.md,readme.md,README.rst, etc.)docs/,doc/, anddocumentation/directoriesHow Has This Been Tested?
Checklist
☑️ My code follows the existing code style of the project
☑️ I have performed a self-review of my own code
☑️ I have added/updated tests where necessary
☑️ My changes do not introduce any new warnings or errors
☑️ I have linked the related issue