Add subdirectory URL syntax documentation to README #254
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
Document how to access specific subdirectories using GitHub tree URLs with gitingest repo examples. Co-Authored-By: sketch
There was a problem hiding this comment.
Pull Request Overview
This PR adds examples to demonstrate how to use gitingest with subdirectory URLs for both the CLI and Python API.
- Adds a CLI snippet showing how to target a specific subdirectory via GitHub’s tree URL.
- Adds a Python
ingest()snippet illustrating the same subdirectory usage. - Ensures examples align with existing private repository token guidance.
Comments suppressed due to low confidence (2)
README.md:124
- [nitpick] Capitalize the comment to keep consistent heading style (
# Or from a specific subdirectory).
# or from a specific subdirectory
README.md:88
- [nitpick] Consider noting that the
mainsegment can be replaced with any branch or tag to fetch a subdirectory from a different branch.
gitingest https://github.com/cyclotruc/gitingest/tree/main/src/gitingest/utils
filipchristiansen
requested changes
Jun 21, 2025
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.
Document how to access specific subdirectories using GitHub tree URLs with gitingest repo examples.