Skip to content

[AAASM-3549] 🐛 (docs): Restore mkdocs search plugin#166

Merged
Chisanan232 merged 1 commit into
masterfrom
v0.0.1/AAASM-3549/restore_mkdocs_search
Jun 22, 2026
Merged

[AAASM-3549] 🐛 (docs): Restore mkdocs search plugin#166
Chisanan232 merged 1 commit into
masterfrom
v0.0.1/AAASM-3549/restore_mkdocs_search

Conversation

@Chisanan232

Copy link
Copy Markdown
Contributor

Description

The MkDocs site lost its search bar because mkdocs.yml's explicit plugins: list omitted the built-in search plugin. Declaring any plugin disables MkDocs' implicit defaults, so with only mkdocstrings and mike listed, search was no longer loaded and no search index was emitted.

This PR adds - search as the first entry under plugins:, restoring the search bar and the generated search index. Only that one entry changed — nothing else in mkdocs.yml was touched.

Type of Change

  • ✨ New feature
  • 🔧 Bug fix
  • ♻️ Refactoring
  • 🍀 Performance improvement
  • 📚 Documentation update
  • 🚀 Release

Breaking Changes

  • No
  • Yes (please describe below)

Related Issues

  • Related JIRA ticket: AAASM-3549
  • Related GitHub issues: #XX

Testing

Describe the testing performed for this PR:

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No tests required (explain why)

uv run --group docs mkdocs build --strict builds cleanly (the only non-fatal note is the pre-existing release/RUNBOOK.md not-in-nav INFO). The search index is regenerated at site/search/search_index.json (~270 KB), confirming the search plugin is loaded again.

Checklist

  • Code follows project style guidelines
  • Self-review completed
  • Comments added for complex logic
  • Documentation updated if needed
  • All tests passing

The explicit `plugins:` list in mkdocs.yml only declared `mkdocstrings`
and `mike`. Declaring any plugin disables MkDocs' implicit defaults, so
the built-in `search` plugin was no longer loaded and the rendered site
lost its search bar (no search index emitted).

Add `- search` as the first plugin entry to restore the search bar and
the generated search index. Verified with `mkdocs build --strict`:
clean build (only the pre-existing release/RUNBOOK.md not-in-nav INFO)
and `site/search/search_index.json` is regenerated.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Chisanan232

Copy link
Copy Markdown
Contributor Author

Claude Code — review result

CI greenAnalyze (python), CodeQL, and Build documentation (PR, no deploy) all pass (deploy steps skip on PR, as expected). No SonarCloud/coverage failures.

Scope vs AAASM-3549 — fully covered. The Python SDK docs had lost their search bar because mkdocs.yml's explicit plugins: list omitted the default search plugin (mkdocs disables implicit defaults once plugins: is declared). This PR adds - search as the first plugin entry — a one-line, single-concern fix; nothing else touched. Verified mkdocs build --strict is clean and site/search/search_index.json is regenerated (only emitted when the search plugin loads), so the search bar is restored.

Ready for approval + merge. Minimal, correct fix matching the ticket exactly.

@Chisanan232 Chisanan232 merged commit 6dd3771 into master Jun 22, 2026
6 checks passed
@Chisanan232 Chisanan232 deleted the v0.0.1/AAASM-3549/restore_mkdocs_search branch June 22, 2026 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant