Skip to content

DOCSTOOLS-6553: document audience-specific content - #346

Merged
goldserg merged 4 commits into
masterfrom
codex/DOCSTOOLS-6553-audience-content
Sep 16, 2026
Merged

goldserg merged 4 commits into
masterfrom
codex/DOCSTOOLS-6553-audience-content

Conversation

@goldserg

@goldserg goldserg commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Tracker: https://st.yandex-team.ru/DOCSTOOLS-6553

Summary:

  • document singular human and agent visibility values
  • document agent HTML, Markdown companion, and JSON requests
  • document fail-closed rendering and YFM023 validation

Dependencies:

Apply after the package releases are available.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (2)

⚠️ en/guides/openapi.md: 168: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 265] [Context: " — the specification is displayed directly on the page (default value). If the size of the specification's json schema exceeds the value of ##maxOpenapiIncludeSize## (100 KB by default), the mode automatically switches to "]

⚠️ en/tools/docs/build.md: 52: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 109] [Context: " — a snapshot of the dependency graph (pages, included files, assets, missing paths, edge count), as well as "]

@github-actions

Copy link
Copy Markdown

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (2)

⚠️ en/guides/openapi.md: 168: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 265] [Context: " — the specification is displayed directly on the page (default value). If the size of the specification's json schema exceeds the value of ##maxOpenapiIncludeSize## (100 KB by default), the mode automatically switches to "]

⚠️ en/tools/docs/build.md: 52: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 109] [Context: " — a snapshot of the dependency graph (pages, included files, assets, missing paths, edge count), as well as "]

@github-actions

Copy link
Copy Markdown

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (2)

⚠️ en/guides/openapi.md: 168: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 265] [Context: " — the specification is displayed directly on the page (default value). If the size of the specification's json schema exceeds the value of ##maxOpenapiIncludeSize## (100 KB by default), the mode automatically switches to "]

⚠️ en/tools/docs/build.md: 52: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 109] [Context: " — a snapshot of the dependency graph (pages, included files, assets, missing paths, edge count), as well as "]

Comment thread en/syntax/audience.md Outdated
:::
```

The regular HTML and Markdown output includes common and `human` content. Agent-oriented output, such as `llms-full.txt`, includes common and `agent` content. The directive markers themselves are not included in either result.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"The regular HTML and Markdown output includes common and human content ... markers are not included in either result" does not match the build: none of these PRs touch output-md, so yfm build -f md keeps both bodies and the raw ::: markers verbatim, which I checked on a fixture. That is intentional so translation and the viewer can filter later, but the sentence promises the opposite. Reword it to say markers survive in md output on purpose, and keep the "stripped" claim for html and llms-full?

@goldserg
goldserg merged commit 1c625f8 into master Sep 16, 2026
1 check passed
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.

2 participants