Skip to content

Regenerate MkDocs search index to remove stale :contentReference artifacts - #4

Merged
Dakout merged 2 commits into
fix_oai_cite_in_contributor_guidelinesfrom
copilot/fix-code-review-comment
Aug 12, 2026
Merged

Dakout merged 2 commits into
fix_oai_cite_in_contributor_guidelinesfrom
copilot/fix-code-review-comment

Conversation

Copilot AI commented Aug 12, 2026 •

Copy link
Copy Markdown
Contributor

The linked review comment requested fixing only the stale citation-token artifacts that remained in generated search results. This update is scoped to that comment and ensures the search index reflects the current source Markdown content.

  • Scope

    • Updated only docs/search/search_index.json (no source Markdown or unrelated generated pages changed).
  • Search index content correction

    • Removed stale :contentReference[oaicite:…] fragments from contributor-guidelines search entries by regenerating the index from src_docs.
    • Preserved intended sentence text (e.g., leading clause in “According to the GitHub workshop slides, …”) as present in source docs.
  • Before/after example (indexed text)

    // before
    "According to the GitHub workshop slides :contentReference[oaicite:1]{index=1}, repositories should typically contain:"
    
    // after
    "According to the GitHub workshop slides, repositories should typically contain:"

Co-authored-by: DanielHettegger <8104927+DanielHettegger@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix code based on review comment Regenerate MkDocs search index to remove stale :contentReference artifacts Aug 12, 2026
Copilot AI requested a review from DanielHettegger August 12, 2026 11:34
@DanielHettegger
DanielHettegger marked this pull request as ready for review August 12, 2026 11:38
@DanielHettegger
DanielHettegger self-requested a review August 12, 2026 11:41
@Dakout
Dakout self-requested a review August 12, 2026 11:46

@Dakout Dakout left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@Dakout
Dakout merged commit 0c04773 into main Aug 12, 2026
@DanielHettegger
DanielHettegger deleted the copilot/fix-code-review-comment branch August 12, 2026 11:50
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.

3 participants