Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-reference/developer-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ npm run dev
- Starts on `http://localhost:8000` (`api/testnet/src/index.ts:18-23,75-81`).
- `GET /` returns index JSON with available endpoints (`api/testnet/src/index.ts:26-47`).

## Headers
## Headers##
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Fix invalid Markdown heading syntax.

The heading is malformed. Closed ATX-style headings in Markdown require a space before the closing hashes: ## Text ##, not ## Text##. The original ## Headers was valid; the change introduces a syntax error that static analysis tools flag (MD020).

🔧 Proposed fix
-## Headers##
+## Headers

Or, if you prefer closed ATX-style:

-## Headers##
+## Headers ##
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Headers##
## Headers
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

16-16: No space inside hashes on closed atx style heading

(MD020, no-missing-space-closed-atx)

🤖 Prompt for AI Agents
In @api-reference/developer-quickstart.md at line 16, The Markdown heading "##
Headers##" is malformed; update the heading in
api-reference/developer-quickstart.md to valid ATX syntax by either using an
open heading "## Headers" or adding a space before the closing hashes to use a
closed heading "## Headers ##" so static linters (MD020) no longer flag it.


- CORS allows standard headers and `X-ACTA-Key` (`api/testnet/src/config/cors.ts:4-23`).
-CORS allows standard headers and `X-ACTA-Key` (`api/testnet/src/config/cors.ts:4-23`).
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Restore the space after the list dash.

Markdown list items require a space after the dash: - item, not -item. The change breaks the list formatting and will render incorrectly.

🔧 Proposed fix
--CORS allows standard headers and `X-ACTA-Key` (`api/testnet/src/config/cors.ts:4-23`).
+- CORS allows standard headers and `X-ACTA-Key` (`api/testnet/src/config/cors.ts:4-23`).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
-CORS allows standard headers and `X-ACTA-Key` (`api/testnet/src/config/cors.ts:4-23`).
- CORS allows standard headers and `X-ACTA-Key` (`api/testnet/src/config/cors.ts:4-23`).
🤖 Prompt for AI Agents
In @api-reference/developer-quickstart.md at line 18, The markdown list item in
developer-quickstart.md currently uses a dash without a following space (e.g.,
"-item"); update that list entry so it reads with a space after the dash ("-
item") to restore proper Markdown list formatting, specifically for the line
mentioning "CORS allows standard headers and `X-ACTA-Key`
(`api/testnet/src/config/cors.ts:4-23`)" so the bullet renders correctly.