docs: add Tenstorrent theme, search/AI modal, and OpenSearch indexing#5484
Open
ctr-fmamedov-crypto wants to merge 6 commits into
Open
docs: add Tenstorrent theme, search/AI modal, and OpenSearch indexing#5484ctr-fmamedov-crypto wants to merge 6 commits into
ctr-fmamedov-crypto wants to merge 6 commits into
Conversation
ctr-fmamedov-crypto
requested review from
AleksKnezevic,
kmabeeTT,
mrakitaTT,
nsumrakTT,
nvukobratTT,
odjuricicTT,
rpavlovicTT,
vmilosevic and
vvukomanTT
as code owners
nsumrakTT
approved these changes
Jul 1, 2026
5 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5484 +/- ##
==========================================
- Coverage 33.85% 33.81% -0.05%
==========================================
Files 37 37
Lines 4989 4989
==========================================
- Hits 1689 1687 -2
- Misses 3300 3302 +2 ☔ View full report in Codecov by Harness. |
html_theme_options: collapse_navigation=False, titles_only=True,
navigation_depth=2
extensions: add sphinx_sitemap with sitemap_locales=[None] and
sitemap_url_scheme="{link}" — consistent with other Tenstorrent docs
html_context: add search_site_base_url for Search / Ask AI modal
html_css_files with docs.tenstorrent.com CDN URL is preserved as-is
(already correct in production)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
layout.html: replace minimal sidebar-only template with full Tenstorrent
Figma layout — top navbar (cross-docs navigation), Search / Ask AI modal
(Kapa.ai, id c37e0bab-...), simplified sidebartitle, versions block
suppressed, footer loads sidebar-scroll.js + tt-search.js from CDN
(docs.tenstorrent.com/_static/ — shared scripts not in this repo's _static/)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
call-build-and-deploy-docs.yml: add environment: github-pages to build
job, add OpenSearch env vars (DOC_SITE_BASE_URL = docs.tenstorrent.com/
tt-xla, DOCS_SEARCH_INGEST_API_KEY secret), add warn + index steps with
continue-on-error: true so failures never block page deploys
scripts/index_remote_search.py: generic HTML crawler that batches pages
and POSTs to the OpenSearch ingest API; all config from env vars
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
sphinx_sitemap was added to conf.py extensions but the package was missing from requirements, causing sphinx-build to fail immediately. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- call-build-and-deploy-docs.yml: wrap run: value in block scalar (|) to avoid YAML parser treating "indexing: ..." as a mapping key - index_remote_search.py: apply isort/black line-length formatting (re.sub/re.search calls, _build_documents signature, blank line) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ctr-fmamedov-crypto
force-pushed
the
docs/theme-search-opensearch
branch
from
5bfce97 to
ea420d7
Compare
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
3 participants
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.
Summary
Migrates the TT-XLA docs to the shared Tenstorrent docs theme and adds OpenSearch-backed search. This is a re-submission of #5419 opened directly from the upstream branch to enable full CI runs.
docs/source/_templates/layout.html: Replace minimal RTD template with full Tenstorrent layout — top navbar with cross-docs navigation (Get Started / Software / Hardware / Tools / Resources), Search / Ask AI modal (Kapa.ai),sidebar-scroll.jsandtt-search.jsloaded from CDN (docs.tenstorrent.com/_static/)docs/source/conf.py: Addsphinx_sitemapextension,html_theme_options,search_site_base_urlinhtml_context— consistent with other Tenstorrent docs sitesscripts/index_remote_search.py+.github/workflows/call-build-and-deploy-docs.yml: HTML crawler that batches pages and POSTs to the OpenSearch ingest API; triggered after each docs deploy viaDOCS_SEARCH_INGEST_API_KEY_DOCS_TENSTORRENTsecret (continue-on-error: trueso missing key never blocks deploys)docs/requirements-docs.txt: Addsphinx-sitemap==2.6.0Closes #5419
Test plan
pip install -r docs/requirements-docs.txt && sphinx-build docs/source docs/build/html— should complete without errorssitemap.xmlis generated indocs/build/html/⌘KDOCS_SEARCH_INGEST_API_KEY_DOCS_TENSTORRENTsecret in repo settings to enable OpenSearch indexing on deploy🤖 Generated with Claude Code