From 77582be805dc714ed9cbe3bdeb46c8975233a2bb Mon Sep 17 00:00:00 2001 From: Nick Vigilante Date: Thu, 16 Jul 2026 10:56:55 -0400 Subject: [PATCH] fix: close tag in generated audit log table header (#27293) ## What The audit log resource table header in `docs/admin/security/audit-logs.md` was emitted as `Resource`: a second opening `` instead of a closing ``. Because the bold element never closes, Markdown/HTML renderers can bold content well beyond the header cell. The page is generated (``), so the fix belongs in the generator, `scripts/auditdocgen/main.go`, with the doc regenerated from it. ## Changes - `scripts/auditdocgen/main.go`: emit a closing `` instead of a second `` in the table header row. - `docs/admin/security/audit-logs.md`: regenerated with `make docs/admin/security/audit-logs.md`; only the header cell changes. ## Verification
Regenerated doc and local checks Header cell before (unclosed tag): ```text | Resource | ... ``` Header cell after (balanced tag): ```text | Resource | ... ``` - `make docs/admin/security/audit-logs.md` regenerates the page from the fixed generator and changes only the header cell (single line; the table stays aligned). - Local `make pre-commit` passed with `GEN_SKIP_GOLDEN=1` (this workspace has no Docker daemon for the golden-file gen step, which this change does not touch): `gen`, `fmt`, `lint/go`, `lint/ts`, `lint/markdown`, `lint/typos`, `lint/emdash`, and the slim binary build all green.
## Linear DOCS-580: https://linear.app/codercom/issue/DOCS-580/fix-unclosed-b-tag-in-generated-audit-logs-table-header --- This PR was created using AI (Coder Agents) on behalf of @nickvigilante, who is accountable for its contents. See the [AI Contribution guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING). --- docs/admin/security/audit-logs.md | 2 +- scripts/auditdocgen/main.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/admin/security/audit-logs.md b/docs/admin/security/audit-logs.md index 693a715a95..43b0f413f6 100644 --- a/docs/admin/security/audit-logs.md +++ b/docs/admin/security/audit-logs.md @@ -13,7 +13,7 @@ We track the following resources: -| Resource | | | +| Resource | | | |-----------------------------------------------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | AIGatewayKey
create, delete | |
FieldTracked
created_atfalse
hashed_secrettrue
idtrue
last_heartbeat_atfalse
nametrue
secret_prefixtrue
| | AIProvider
create, write, delete | |
FieldTracked
base_urltrue
created_atfalse
deletedtrue
display_nametrue
enabledtrue
icontrue
idtrue
nametrue
settingstrue
settings_key_idfalse
typetrue
updated_atfalse
| diff --git a/scripts/auditdocgen/main.go b/scripts/auditdocgen/main.go index 66c8f4384b..800cdda38d 100644 --- a/scripts/auditdocgen/main.go +++ b/scripts/auditdocgen/main.go @@ -114,7 +114,7 @@ func updateAuditDoc(doc []byte, auditableResourcesMap AuditableResourcesMap) ([] _, _ = buffer.Write(doc[:tableStartIndex]) _ = buffer.WriteByte('\n') - _, _ = buffer.WriteString("|Resource||\n") + _, _ = buffer.WriteString("|Resource||\n") _, _ = buffer.WriteString("|--|-----------------|\n") for _, resourceName := range sortedResourceNames {