Skip to content

Commit

Permalink
Update README about site's search functionality (#49475)
Browse files Browse the repository at this point in the history
Co-authored-by: Peter Bengtsson <peterbe@github.com>
  • Loading branch information
mattpollard and peterbe authored Mar 4, 2024
1 parent 56b4e3b commit 7249dcb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The site search is part of every version of docs.github.com. This endpoint respo
You can also query our search endpoint directly at:
`https://docs.github.com/search?version=<VERSION>&language=<LANGUAGE CODE>&filters=topics:<TOPIC>&query=<QUERY>`

- The VERSION can be any numbered GitHub Enterprise Server version (e.g., `2.22`, `3.0`), GitHub AE (`ghae`), or the Free pro team plan (`dotcom`).
- The VERSION can be any numbered supported GitHub Enterprise Server version (e.g., `3.12`), Enterprise Cloud (`ghec`), or the Free pro team plan (`dotcom`).
- The LANGUAGE CODE can be one of: `zh`, `es`, `pt`, `ru`, `ja`, `fr`, `de`, `ko`
- TOPIC can be any topics in [the allowed list of topics](/data/allowed-topics.js). The values in the `topics` attribute are **not** case sensitive, so filtering on `GitHub actions` or `github actions` will return the same result. **Note:** Currently, the topics filter only works for the dotcom version in the English language. We plan to expand this search query to other languages and versions in the future.
- Any search QUERY you'd like.
Expand Down

1 comment on commit 7249dcb

@sksakir

This comment was marked as spam.

Please sign in to comment.