fix: Make sure <key> renders properly

AbhiPrasad · AbhiPrasad · commit 02537a10d60f · 2025-03-23T00:34:20.000-04:00
diff --git a/generated/attributes/code.md b/generated/attributes/code.md
@@ -7,10 +7,10 @@
   - [code.function.name](#codefunctionname)
   - [code.line.number](#codelinenumber)
 - [Deprecated Attributes](#deprecated-attributes)
-  - [code.filepath](#code-filepath)
-  - [code.function](#code-function)
-  - [code.lineno](#code-lineno)
-  - [code.namespace](#code-namespace)
+  - [code.filepath](#codefilepath)
+  - [code.function](#codefunction)
+  - [code.lineno](#codelineno)
+  - [code.namespace](#codenamespace)
 
 ## Stable Attributes
 
diff --git a/generated/attributes/db.md b/generated/attributes/db.md
@@ -6,18 +6,18 @@
   - [db.collection.name](#dbcollectionname)
   - [db.namespace](#dbnamespace)
   - [db.operation.name](#dboperationname)
-  - [db.query.parameter.<key>](#dbqueryparameterkey)
+  - [db.query.parameter.\<key\>](#dbqueryparameterkey)
   - [db.query.text](#dbquerytext)
   - [db.redis.connection](#dbredisconnection)
   - [db.redis.parameters](#dbredisparameters)
   - [db.system.name](#dbsystemname)
   - [db.user](#dbuser)
 - [Deprecated Attributes](#deprecated-attributes)
-  - [db.name](#db-name)
-  - [db.operation](#db-operation)
-  - [db.sql.bindings](#db-sql-bindings)
-  - [db.statement](#db-statement)
-  - [db.system](#db-system)
+  - [db.name](#dbname)
+  - [db.operation](#dboperation)
+  - [db.sql.bindings](#dbsqlbindings)
+  - [db.statement](#dbstatement)
+  - [db.system](#dbsystem)
 
 ## Stable Attributes
 
diff --git a/generated/attributes/gen_ai.md b/generated/attributes/gen_ai.md
@@ -8,8 +8,8 @@
   - [gen_ai.usage.input_tokens](#gen_aiusageinput_tokens)
   - [gen_ai.usage.output_tokens](#gen_aiusageoutput_tokens)
 - [Deprecated Attributes](#deprecated-attributes)
-  - [gen_ai.usage.completion_tokens](#gen_ai-usage-completion_tokens)
-  - [gen_ai.usage.prompt_tokens](#gen_ai-usage-prompt_tokens)
+  - [gen_ai.usage.completion_tokens](#gen_aiusagecompletion_tokens)
+  - [gen_ai.usage.prompt_tokens](#gen_aiusageprompt_tokens)
 
 ## Stable Attributes
 
diff --git a/generated/attributes/http.md b/generated/attributes/http.md
@@ -11,7 +11,7 @@
   - [http.request.domain_lookup_end](#httprequestdomain_lookup_end)
   - [http.request.domain_lookup_start](#httprequestdomain_lookup_start)
   - [http.request.fetch_start](#httprequestfetch_start)
-  - [http.request.header.<key>](#httprequestheaderkey)
+  - [http.request.header.\<key\>](#httprequestheaderkey)
   - [http.request.method](#httprequestmethod)
   - [http.request.redirect_start](#httprequestredirect_start)
   - [http.request.request_start](#httprequestrequest_start)
@@ -20,24 +20,24 @@
   - [http.request.response_start](#httprequestresponse_start)
   - [http.request.secure_connection_start](#httprequestsecure_connection_start)
   - [http.response.body.size](#httpresponsebodysize)
-  - [http.response.header.<key>](#httpresponseheaderkey)
+  - [http.response.header.\<key\>](#httpresponseheaderkey)
   - [http.response.header.content-length](#httpresponseheadercontentlength)
   - [http.response.size](#httpresponsesize)
   - [http.response.status_code](#httpresponsestatus_code)
   - [http.route](#httproute)
 - [Deprecated Attributes](#deprecated-attributes)
-  - [http.client_ip](#http-client_ip)
-  - [http.flavor](#http-flavor)
-  - [http.host](#http-host)
-  - [http.method](#http-method)
-  - [http.response_content_length](#http-response_content_length)
-  - [http.response_transfer_size](#http-response_transfer_size)
-  - [http.scheme](#http-scheme)
-  - [http.server_name](#http-server_name)
-  - [http.status_code](#http-status_code)
-  - [http.target](#http-target)
-  - [http.url](#http-url)
-  - [http.user_agent](#http-user_agent)
+  - [http.client_ip](#httpclient_ip)
+  - [http.flavor](#httpflavor)
+  - [http.host](#httphost)
+  - [http.method](#httpmethod)
+  - [http.response_content_length](#httpresponse_content_length)
+  - [http.response_transfer_size](#httpresponse_transfer_size)
+  - [http.scheme](#httpscheme)
+  - [http.server_name](#httpserver_name)
+  - [http.status_code](#httpstatus_code)
+  - [http.target](#httptarget)
+  - [http.url](#httpurl)
+  - [http.user_agent](#httpuser_agent)
 
 ## Stable Attributes
 
diff --git a/generated/attributes/net.md b/generated/attributes/net.md
@@ -3,21 +3,21 @@
 # Net Attributes
 
 - [Deprecated Attributes](#deprecated-attributes)
-  - [net.host.ip](#net-host-ip)
-  - [net.host.name](#net-host-name)
-  - [net.host.port](#net-host-port)
-  - [net.peer.ip](#net-peer-ip)
-  - [net.peer.name](#net-peer-name)
-  - [net.peer.port](#net-peer-port)
-  - [net.protocol.name](#net-protocol-name)
-  - [net.protocol.version](#net-protocol-version)
-  - [net.sock.family](#net-sock-family)
-  - [net.sock.host.addr](#net-sock-host-addr)
-  - [net.sock.host.port](#net-sock-host-port)
-  - [net.sock.peer.addr](#net-sock-peer-addr)
-  - [net.sock.peer.name](#net-sock-peer-name)
-  - [net.sock.peer.port](#net-sock-peer-port)
-  - [net.transport](#net-transport)
+  - [net.host.ip](#nethostip)
+  - [net.host.name](#nethostname)
+  - [net.host.port](#nethostport)
+  - [net.peer.ip](#netpeerip)
+  - [net.peer.name](#netpeername)
+  - [net.peer.port](#netpeerport)
+  - [net.protocol.name](#netprotocolname)
+  - [net.protocol.version](#netprotocolversion)
+  - [net.sock.family](#netsockfamily)
+  - [net.sock.host.addr](#netsockhostaddr)
+  - [net.sock.host.port](#netsockhostport)
+  - [net.sock.peer.addr](#netsockpeeraddr)
+  - [net.sock.peer.name](#netsockpeername)
+  - [net.sock.peer.port](#netsockpeerport)
+  - [net.transport](#nettransport)
 
 ## Deprecated Attributes
 
diff --git a/generated/attributes/params.md b/generated/attributes/params.md
@@ -3,7 +3,7 @@
 # Params Attributes
 
 - [Stable Attributes](#stable-attributes)
-  - [params.<key>](#paramskey)
+  - [params.\<key\>](#paramskey)
 
 ## Stable Attributes
 
diff --git a/generated/attributes/query.md b/generated/attributes/query.md
@@ -3,7 +3,7 @@
 # Query Attributes
 
 - [Deprecated Attributes](#deprecated-attributes)
-  - [query.<key>](#query-key-)
+  - [query.\<key\>](#querykey)
 
 ## Deprecated Attributes
 
diff --git a/generated/attributes/remix.md b/generated/attributes/remix.md
@@ -3,7 +3,7 @@
 # Remix Attributes
 
 - [Stable Attributes](#stable-attributes)
-  - [remix.action_form_data.<key>](#remixaction_form_datakey)
+  - [remix.action_form_data.\<key\>](#remixaction_form_datakey)
 
 ## Stable Attributes
 
diff --git a/generated/attributes/url.md b/generated/attributes/url.md
@@ -7,7 +7,7 @@
   - [url.fragment](#urlfragment)
   - [url.full](#urlfull)
   - [url.path](#urlpath)
-  - [url.path.params.<key>](#urlpathparamskey)
+  - [url.path.params.\<key\>](#urlpathparamskey)
   - [url.port](#urlport)
   - [url.query](#urlquery)
   - [url.scheme](#urlscheme)
diff --git a/scripts/generate_attribute_docs.ts b/scripts/generate_attribute_docs.ts
@@ -62,8 +62,6 @@ function generateAttributeTable(attribute: AttributeJson): string {
 
   table += '\n';
 
-  table = table.replaceAll('<key>', '\\<key\\>');
-
   return table;
 }
 
@@ -156,6 +154,8 @@ async function generateAttributeDocs() {
       }
     }
 
+    markdown = markdown.replaceAll('<key>', '\\<key\\>');
+
     // Write the markdown file
     const outputFile = path.join(outputDir, `${category}.md`);
     fs.writeFileSync(outputFile, markdown);

Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,6 @@ function generateAttributeTable(attribute: AttributeJson): string {`
`62`	`62`
`63`	`63`	`table += '\n';`
`64`	`64`
`65`		`- table = table.replaceAll('<key>', '\\<key\\>');`
`66`		`-`
`67`	`65`	`return table;`
`68`	`66`	`}`
`69`	`67`
`@@ -156,6 +154,8 @@ async function generateAttributeDocs() {`
`156`	`154`	`}`
`157`	`155`	`}`
`158`	`156`
	`157`	`+ markdown = markdown.replaceAll('<key>', '\\<key\\>');`
	`158`	`+`
`159`	`159`	`// Write the markdown file`
`160`	`160`	const outputFile = path.join(outputDir, `${category}.md`);
`161`	`161`	`fs.writeFileSync(outputFile, markdown);`