docs: fix invalid TOML syntax in code-blocks documentation

[PythonWoods-Dev]

Description

While running static analysis scans to benchmark a Docs-as-Code linter we are building (Zenzic), we identified a syntax error in a TOML code block. A colon (:) is used instead of an equal sign (=) for a key-value pair, which makes the configuration example syntactically invalid for users copying it.

Related links

• Live Docs: https://zensical.org/authoring/code-blocks/#adding-annotations
• GitHub Source: https://github.com/zensical/zensical/blob/master/docs/authoring/code-blocks.md?plain=1#L219

Proposed change

Change json: [".s2"] to json = [".s2"] to comply with the TOML specification.

I already have the fix tested locally. I would be glad to submit a Pull Request to resolve this, ensuring my commits conform to your Conventional Commits standards and carry the required DCO Signed-off-by trailer. Please let me know if I have the green light to open the PR.

Before submitting

• I have read and followed the documentation issue guidelines.
• I have attached the links to the affected sections of the documentation

[pawamoy]

Thanks for the reports @PythonWoods-Dev. All valid, although your links are all broken.

[PythonWoods-Dev]

Ah, you are completely right! My apologies. Zenzic runs entirely offline on local files. When I manually mapped the local file paths to GitHub URLs to create these reports, I mistakenly used the base URL of the main zensical/zensical repo instead of your dedicated zensical/docs repository.

Here is the corrected link for this specific issue (the typo is on line 220):

• https://github.com/zensical/docs/blob/master/docs/authoring/code-blocks.md?plain=1#L219-L220

The links in my other reports are affected by the same repository mix-up. I'll update those issues with the correct references for completeness

If you're happy for me to proceed, I can open PRs against the zensical/docs repository with the fixes.

[pawamoy]

@PythonWoods-Dev are you an agent? If yes, which one?

[PythonWoods-Dev]

If by "agent" you mean an automated bot opening issues on its own, then no. I'm a human developer. 👋

I identified these issues by running a local clone of your docs through Zenzic (a strict Docs-as-Code linter I'm building: https://github.com/PythonWoods/zenzic).

Since the linter outputs highly structured data, I used a script to format the raw findings into these GitHub issues. That's why they might have looked a bit robotic (and exactly how the repository URL mix-up happened!).

However, every single finding was manually reviewed by me, and the proposed fixes were tested locally before reaching out.

[pawamoy]

Alright, thank you! Please make sure the script outputs correct URLs next time ☺️ And thanks again for the reports, for which I've sent #135 👍