Skip to content

Conversation

novusnota
Copy link
Member

@novusnota novusnota commented Oct 9, 2025

Closes #153. Also adds a couple of small nearby edits — I care for better search both inside and outside the docs :)

This page turned out to be quite nice. One remark could be to move the common language descriptions (see relevant ### headings) to the /ecosystem/ide/overview page, so that those individual ones won't be repetitive, but I'm not sure here. This could be done in another PR, with the VSCode page or the overview page itself.

image

...

image

And a couple small nearby edits
@novusnota novusnota requested a review from verytactical October 9, 2025 01:15

This comment was marked as resolved.

Copy link

github-actions bot commented Oct 9, 2025

Thanks for the updates to the JetBrains IDE docs. A couple of style‑guide fixes are needed before this can merge.

Findings (2)

High (2)

[HIGH] UI strings use code/keyboard styling instead of quotation marks

Location:

1. In the IDE, open <kbd><Icon icon="gear" size={16} /> Settings</kbd><br />
Skip this step if you do not have opened projects and are in the start menu
1. Go to <kbd>Plugins</kbd>
1. Select the <kbd>Marketplace</kbd> tab (default)
1. Search for `TON`
1. Select the official plugin from TON Core and click <kbd>Install</kbd>
The plugin would be fetched and installed in your current JetBrains IDE. You might need to restart it for changes to take effect.
Here is how the plugin installation page may look in the start menu of WebStorm, before pressing the <kbd>Install</kbd> button:
![Screenshot of the plugin installation](/resources/images/intellij-ton/it-install-from-settings.png)
Alternatively, you can press <kbd>Get</kbd> on the [plugin homepage in the JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23382-ton) and then follow subsequent instructions.
### From disk
To manually install the plugin:
1. Download the plugin archive from the [latest GitHub release](https://github.com/ton-blockchain/intellij-ton/releases/latest) or from the exact version [on the marketplace](https://plugins.jetbrains.com/plugin/23382-ton/versions)
1. In the IDE, open <kbd><Icon icon="gear" size={16} /> Settings</kbd><br />
Skip this step if you do not have opened projects and are in the start menu
1. Go to <kbd>Plugins</kbd>
1. Click the gear icon on top <kbd><Icon icon="gear" size={16} /></kbd> and then select `Install Plugin from Disk...`
1. Select the plugin archive in the pop up and complete the installation

Description:
In the installation steps, literal UI/menu labels are wrapped in <kbd> or backticks. The style guide requires these strings to appear verbatim in double quotation marks, with punctuation outside unless part of the label. This pattern repeats across this section (e.g., ecosystem/ide/jetbrains.mdx:44, :48, :55, :57-:58) and may hinder translation, searchability, and copy/paste.

Suggestion:

-1. In the IDE, open <kbd><Icon icon="gear" size={16} /> Settings</kbd><br />
+1. In the IDE, open "Settings"<br />
-1. Go to <kbd>Plugins</kbd>
+1. Go to "Plugins"
-1. Select the <kbd>Marketplace</kbd> tab (default)
+1. Select the "Marketplace" tab (default)
-1. Select the official plugin from TON Core and click <kbd>Install</kbd>
+1. Select the official plugin from TON Core and click "Install"
--- a/ecosystem/ide/jetbrains.mdx
+++ b/ecosystem/ide/jetbrains.mdx
@@
-1. In the IDE, open <kbd><Icon icon="gear" size={16} /> Settings</kbd><br />
+1. In the IDE, open <Icon icon="gear" size={16} /> “Settings”<br />
@@
-1. Go to <kbd>Plugins</kbd>
+1. Go to “Plugins”
@@
-1. Select the <kbd>Marketplace</kbd> tab (default)
+1. Select the “Marketplace” tab (default)
@@
-1. Select the official plugin from TON Core and click <kbd>Install</kbd>
+1. Select the official plugin from TON Core and click “Install”.
@@
-Here is how the plugin installation page may look in the start menu of WebStorm, before pressing the <kbd>Install</kbd> button:
+Here is how the plugin installation page may look in the start menu of WebStorm, before pressing the “Install” button:
@@
-Alternatively, you can press <kbd>Get</kbd> on the [plugin homepage in the JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23382-ton) and then follow subsequent instructions.
+Alternatively, you can press “Get” on the [plugin homepage in the JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23382-ton) and then follow subsequent instructions.
@@
-1. In the IDE, open <kbd><Icon icon="gear" size={16} /> Settings</kbd><br />
+1. In the IDE, open <Icon icon="gear" size={16} /> “Settings”<br />
@@
-1. Go to <kbd>Plugins</kbd>
+1. Go to “Plugins”
@@
-1. Click the gear icon on top <kbd><Icon icon="gear" size={16} /></kbd> and then select `Install Plugin from Disk...`
+1. Click the gear icon on top <Icon icon="gear" size={16} /> and then select “Install Plugin from Disk...”
-1. Click the gear icon on top <kbd><Icon icon="gear" size={16} /></kbd> and then select `Install Plugin from Disk...`
+1. Click the gear icon on top <kbd><Icon icon="gear" size={16} /></kbd> and then select “Install Plugin from Disk...”

[HIGH] Literal ellipsis used in inline code

Location:

- [Code fragment surrounding] — templates for wrapping code fragments in various constructs, such as `try...catch` blocks.

Description:
The phrase try...catch is formatted as inline code with a literal ellipsis, which is not valid syntax. The style guide prohibits placeholder ellipses in code spans because they alter meaning and can lead to incorrect copy/paste.

Suggestion:

-- [Code fragment surrounding] — templates for wrapping code fragments in various constructs, such as `try...catch` blocks.
+- [Code fragment surrounding] — templates for wrapping code fragments in various constructs, such as try-catch blocks.

@novusnota
Copy link
Member Author

novusnota commented Oct 9, 2025

github-actions[bot]: Thanks for the updates to the JetBrains IDE docs. A couple of style‑guide fixes are needed before this can merge.

Regarding these two suggestions:

  1. First one is just bad, because the icons and <kbd> elements express literal buttons in the interface and there are no copy-paste concerns either.
  2. Neither try-catch (suggested) nor try...catch (current) are valid syntax, but the latter is easier on the eyes, used in Tact and FunC, and is also seen in other docs, such as those written by JetBrains for their IDEs and for Kotlin. As this page is about the JetBrains IDE plugin, I believe the current stylistic choice (try...catch) is further solidified.

TL;DR: wontfix 😛

- [Usages]
- [Inspections]

### TASM
Copy link
Member

Choose a reason for hiding this comment

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

need a screenshot with highlighted TASM syntax

Comment on lines +231 to +232
- [`@tondev_eng` on Telegram](https://t.me/tondev_eng) — Main TON community chat and discussion group.
- [`@tondev` on Telegram](https://t.me/tondev) — Main Russian TON community chat and discussion group.
Copy link
Member

Choose a reason for hiding this comment

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

these are generic chats, let's remove these

- [`@tondev_eng` on Telegram](https://t.me/tondev_eng) — Main TON community chat and discussion group.
- [`@tondev` on Telegram](https://t.me/tondev) — Main Russian TON community chat and discussion group.

## See also
Copy link
Member

Choose a reason for hiding this comment

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

We don't want to maintain these links, let's remove

Copy link
Member

Choose a reason for hiding this comment

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

why changes in this file?

Copy link
Member

Choose a reason for hiding this comment

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

need a light theme screenshot here and in the rest of the screenshots

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.

[Ecosystem > IDE > Jetbrains]
2 participants