elastic / elastic/crd-ref-docs

Ignore a type but still document its fields when embedded

Open
#75 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

#73 changed (fixed) the behavior of `ignoreTypes` so that they are actually excluded from the output. I was previously using the `ignoreTypes` list to ignore types that are only embedded in other structs. The types would not receive their own section/table in the resulting docs, but their fields would still be documented when they were embedded in other structs (with `json:",inline"`). It would be nice if this use case could be supported in the tool.

Contributor guide

Open the contributing guide

Research direction

Start by tracing the ignoreTypes behavior changed in #73 and the handling of embedded structs marked json:",inline". Confirm how ignored types are excluded while their embedded fields remain in generated documentation, then add coverage for this case and verify the generated output.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.