Skip to content

docs: #122 adds llm friendly documentation and indexable response and… #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coreyjs merged 1 commit into from
May 11, 2026
Merged

docs: #122 adds llm friendly documentation and indexable response and… #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions context7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"$schema": "https://context7.com/schema/context7.json",
"projectTitle": "nhl-api-py",
"description": "Python wrapper for the NHL API — stats, schedules, standings, teams, game data, and EDGE analytics",
"folders": ["docs"],
"excludeFolders": ["tests", ".github"],
"excludeFiles": ["CONTRIBUTING.md"],
"rules": [
"Always import from nhlpy: from nhlpy import NHLClient",
"Game IDs format: YYYYTTNNNN (e.g., 2023020280 = 2023 season, regular season game 280)",
"Season format: YYYYYYYY (e.g., 20242025)",
"Method names have no get_ prefix (e.g., boxscore() not get_boxscore())",
"Team abbreviations are 3 letters (e.g., BUF, TOR, EDM)",
"Many name fields use localized format: {\"default\": \"English\", \"fr\": \"French\"}"
]
}
Loading
Loading