Skip to content

Add support checkbox render#3336

Open
groman92 wants to merge 26 commits into
mainfrom
checkbox_render_fix
Open

Add support checkbox render#3336
groman92 wants to merge 26 commits into
mainfrom
checkbox_render_fix

Conversation

@groman92
Copy link
Copy Markdown

@groman92 groman92 commented May 18, 2026

Adding support to checkboxes.

As shown in Cloud Services onboarding document, checkbox are not being rendered correctly also is stated in syntax.md that TaskList ("Checkbox") are not supported.

https://codex.elastic.dev/r/security-team/security-integrations-team/cloud-services/onboarding
Before
image
After
image

reakaleek and others added 20 commits May 20, 2026 16:55
Scrapers and AI crawlers reading /reference pages hit a wall of
navigation HTML before reaching the article. Put <main> first in
DOM order across all three layouts while preserving the visual
layout via CSS Grid order utilities.

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
…da (#3309)

* Add tighter and explicit timeout to S3 Client acquisition

* Add intermediary logs
When `pivot.products` is configured with multiple products but a PR
carries no matching product label (and no `products.default` is set),
`changelog evaluate-pr` would still report `proceed`. The downstream
`changelog add` step then failed with "At least one product is required",
which is a workflow-level hard error and skips the helpful PR comment
that surfaces the missing labels.

Treat this case the same as a missing type label: return `NoLabel` and
emit the product-label-table so the existing comment-failure path posts
an actionable hint to the contributor.

When `pivot.products` defines only one distinct product, assign it
implicitly — no point requiring a redundant label when there is only
one possible answer.

Co-authored-by: Cursor <cursoragent@cursor.com>
…Documentation.Site in the tailwindcss group across 1 directory (#3340)

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: dependabot[bot] <support@github.com>
…on.Site in the eui group across 1 directory (#3339)

Signed-off-by: dependabot[bot] <support@github.com>
…ation.Site (#3341)

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: dependabot[bot] <support@github.com>
* Fix ShouldContainHtml comparing actual HTML to itself

expectedCompare was built from `actual` instead of `expected`, causing
the assertion to always pass regardless of whether the expected fragment
was present in the actual output.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* Fix inline image renderer emitting alt text as title unconditionally

The renderer was always writing title="<alt>" for every image, ignoring
the actual title parsed from the markdown title syntax. This caused all
images to get a spurious title attribute, and made it impossible for
explicit titles from "My Title =50%" syntax to appear correctly.

Use link.Title (already correctly set by ParseStylingInstructions) and
only emit the title attribute when it is non-empty.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* Align C# inline image tests with authoring test ground truth

The F# authoring tests (the ground truth) document that inline images
always use alt text as the title attribute — even when an explicit title
is supplied in the markdown title syntax. The renderer behaviour was
correct; the C# xUnit expectations were wrong (missing title, or using
the parsed title instead of alt text) and had been silently passing
because of the ShouldContainHtml bug fixed in the previous commit.

Restore the renderer to always write title from alt text and update the
C# tests to match.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
* Merge Elastic.Documentation.Api.* into single project

Three projects (Api.Core, Api.Infrastructure, Api.App) collapsed into
Elastic.Documentation.Api. Mcp.Remote no longer references any Api.*
project — its only deps are ServiceDefaults, services/Search, and
services/Assembler.

Key moves:
- EuidSpanProcessor + EuidLogProcessor → ServiceDefaults (shared)
- AddEuidEnrichment helper added to ServiceDefaults
- Search gateway interfaces (IFullSearchGateway, INavigationSearchGateway,
  IChangesGateway) → services/Elastic.Documentation.Search
- McpToolSourceName constant inlined into Mcp.Remote

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* Fix C# import ordering and name simplification after Api merge

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* Fix Dockerfile publish RID to use TARGETARCH/TARGETOS instead of linux-x64

Enables arm64 image builds to publish and copy the correct architecture
artifact rather than always using the amd64 binary.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* Address PR review: OTel source registration, assembly version, env var key

- Register McpTools ActivitySource in Mcp.Remote TracerProvider so MCP
  spans are captured
- Use GetEntryAssembly() over GetCallingAssembly() for service.version so
  the host service's version is reported rather than ServiceDefaults
- OtlpProxyOptions now checks OTEL_EXPORTER_OTLP_ENDPOINT first then
  OTLP_PROXY_ENDPOINT as backward-compatible fallback, matching the
  documented priority order

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* Fix import ordering in Mcp.Remote Program.cs

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* [2/5] VSA: Collapse Gateway+Usecase into *Service per feature (#3335)

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
#3318)

Adds a new :deployment: option to the {settings} directive that hides
settings not available for the specified deployment type (ech, ece, eck,
self). Settings with applies_to metadata that lack an explicit entry for
the requested deployment are treated as unavailable. Settings without
any applies_to metadata are always shown.

Updates docs/syntax/automated_settings.md to document the new option and
adds filtered examples to the Kibana settings test page.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
* Initial plan

* fix: render markdown in magic callouts

Agent-Logs-Url: https://github.com/elastic/docs-builder/sessions/d3957e8a-7eab-4572-9244-4e24fa63a74e

Co-authored-by: leemthompo <32779855+leemthompo@users.noreply.github.com>

* test: align magic callout regression naming

Agent-Logs-Url: https://github.com/elastic/docs-builder/sessions/d3957e8a-7eab-4572-9244-4e24fa63a74e

Co-authored-by: leemthompo <32779855+leemthompo@users.noreply.github.com>

* fix: import markdig for magic callout rendering

Agent-Logs-Url: https://github.com/elastic/docs-builder/sessions/00950126-9a51-427f-9b93-9d838ae7df13

Co-authored-by: leemthompo <32779855+leemthompo@users.noreply.github.com>

* test: fix magic callout link regression fixture

Agent-Logs-Url: https://github.com/elastic/docs-builder/sessions/3df80900-27a1-4d02-b422-7c98e5832c2d

Co-authored-by: leemthompo <32779855+leemthompo@users.noreply.github.com>

* docs: update code callouts section for clarity and inline formatting

Reorder automatic callouts before explicit, add decision guidance,
and document inline Markdown support in callout text.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: don't make people read raw regex

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: expand callout examples and note link limitation

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: fold admonitions into intro prose per review

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: leemthompo <32779855+leemthompo@users.noreply.github.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
_GroupLayout.cshtml was the one sidebar-grid layout missed by PR #3344.
With _PagesNav now carrying md:order-1, the missing md:order-2 on <main>
broke the visual layout of Codex group landing pages.

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@groman92 groman92 temporarily deployed to integration-tests May 20, 2026 15:32 — with GitHub Actions Inactive
@groman92 groman92 changed the title [WIP]Add support checkbox render Add support checkbox render May 20, 2026
@groman92 groman92 marked this pull request as ready for review May 20, 2026 15:44
@groman92 groman92 requested review from a team as code owners May 20, 2026 15:44
@groman92 groman92 requested a review from technige May 20, 2026 15:44
@reakaleek
Copy link
Copy Markdown
Member

Thank you for the contribution!

What are your thoughts on local persistence?

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 20, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds task list support to the documentation builder. The Markdig .UseTaskLists() extension is integrated into the Markdown parsing pipeline. CSS styling handles task list containers, items, and checkbox inputs. A test class validates that rendered HTML includes correct CSS classes and checkbox attributes. Documentation updates include a new task-lists.md page with syntax examples, removal of task lists from the unsupported features list, and navigation entry in the docset configuration.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check ❓ Inconclusive The title 'Add support checkbox render' is vague and uses unclear phrasing ('checkbox render' lacks specificity), making it difficult to understand the primary change from the title alone. Revise to a clearer, more specific title such as 'Add task list and checkbox rendering support' to better convey the feature being implemented.
✅ Passed checks (3 passed)
Check name Status Explanation
Description check ✅ Passed The description is directly related to the changeset, explaining the motivation (checkboxes not rendering correctly, task lists marked as unsupported) and providing before/after evidence of the fix.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch checkbox_render_fix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
tests/Elastic.Markdown.Tests/TaskList/BasicTaskListTests.cs (1)

17-30: ⚡ Quick win

Rename test methods to Method_Scenario_Expected.

The four new test names don’t follow the required test naming convention, which makes suite consistency/searchability weaker.

As per coding guidelines "tests/**/*.cs: ... Test method naming convention: Method_Scenario_Expected."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@tests/Elastic.Markdown.Tests/TaskList/BasicTaskListTests.cs` around lines 17
- 30, Rename the four test methods to follow Method_Scenario_Expected: change
RendersTaskListContainer to Render_TaskListContainer_ContainsTaskListClass,
RendersTaskListItem to Render_TaskListItem_ContainsTaskListItemClass,
RendersUncheckedCheckbox to Render_UncheckedCheckbox_RendersDisabledInput, and
RendersCheckedCheckbox to Render_CheckedCheckbox_RendersDisabledCheckedInput so
they match the tests/**/*.cs naming convention and improve discoverability
(update all references/usages of these method names if any).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@tests/Elastic.Markdown.Tests/TaskList/BasicTaskListTests.cs`:
- Around line 17-30: Rename the four test methods to follow
Method_Scenario_Expected: change RendersTaskListContainer to
Render_TaskListContainer_ContainsTaskListClass, RendersTaskListItem to
Render_TaskListItem_ContainsTaskListItemClass, RendersUncheckedCheckbox to
Render_UncheckedCheckbox_RendersDisabledInput, and RendersCheckedCheckbox to
Render_CheckedCheckbox_RendersDisabledCheckedInput so they match the
tests/**/*.cs naming convention and improve discoverability (update all
references/usages of these method names if any).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: ae2072da-9ce0-4e59-8b91-66d0d300b3b1

📥 Commits

Reviewing files that changed from the base of the PR and between e729f3e and a1604dd.

📒 Files selected for processing (6)
  • docs/_docset.yml
  • docs/syntax/index.md
  • docs/syntax/task-lists.md
  • src/Elastic.Documentation.Site/Assets/markdown/list.css
  • src/Elastic.Markdown/Myst/MarkdownParser.cs
  • tests/Elastic.Markdown.Tests/TaskList/BasicTaskListTests.cs
💤 Files with no reviewable changes (1)
  • docs/syntax/index.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants