Skip to content

Update INSTALL.md#666

Merged
qin-ctx merged 1 commit intomainfrom
yuyaoyoyo-svg-patch-6
Mar 16, 2026
Merged

Update INSTALL.md#666
qin-ctx merged 1 commit intomainfrom
yuyaoyoyo-svg-patch-6

Conversation

@yuyaoyoyo-svg
Copy link
Collaborator

update plugin's EN version

update plugin's english version
@github-actions
Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Typo in Workdir Path

The curl install command has a duplicated "openclaw" in the workdir path, which may confuse users.

curl -fsSL ... | bash -s -- --workdir ~/.openclaw-openclaw-second

</details>

<details><summary><a href='https://github.com/volcengine/OpenViking/pull/666/files#diff-a5a294ae410fd6cce602d0710485509b7e378aca5c12b939e86b7cc779c528cdR184-R188'><strong>Incorrect Code Block Language</strong></a>

An npm install command block is incorrectly marked as Python code, leading to wrong syntax highlighting.
</summary>

```markdown
```python
npm install -g openclaw-openviking-setup-helper
ov-install


</details>

<details><summary><a href='https://github.com/volcengine/OpenViking/pull/666/files#diff-a5a294ae410fd6cce602d0710485509b7e378aca5c12b939e86b7cc779c528cdR3-R3'><strong>Unnecessary Google Search Links</strong></a>

Two links point to Google searches instead of direct URLs, which is redundant and may lead to unexpected results.
</summary>

```markdown
Provide long-term memory capabilities for [OpenClaw](https://github.com/openclaw/openclaw) via [OpenViking](https://github.com/volcengine/OpenViking). After installing, OpenClaw will automatically **remember** important information from conversations and **recall** relevant content before replying. The latest version of OpenViking releases the [WebConsole](https://www.google.com/search?q=https://github.com/volcengine/OpenViking/tree/main/openviking/console) to facilitate debugging and operations. Method 3 in this document also provides instructions on how to verify that memories are written via the WebConsole interface, offering user-friendly and easy-to-understand usage guidelines. We welcome you to try it out and provide feedback.
Unnecessary Google Search Links

Two links point to Google searches instead of direct URLs, which is redundant and may lead to unexpected results.

**See also:** [INSTALL-ZH.md](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-memory-plugin/INSTALL-ZH.md) (Chinese) · [INSTALL-AGENT.md](https://www.google.com/search?q=./INSTALL-AGENT.md) (Agent Install Guide)

@github-actions
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Fix WebConsole link to avoid Google search

Replace the Google search URL with a direct link to the WebConsole GitHub page.
Using a Google search link as a hyperlink target is unnecessary and confusing for
users.

examples/openclaw-memory-plugin/INSTALL.md [3]

-The latest version of OpenViking releases the [WebConsole](https://www.google.com/search?q=https://github.com/volcengine/OpenViking/tree/main/openviking/console) to facilitate debugging and operations.
+The latest version of OpenViking releases the [WebConsole](https://github.com/volcengine/OpenViking/tree/main/openviking/console) to facilitate debugging and operations.
Suggestion importance[1-10]: 4

__

Why: Replaces an unnecessary Google search URL with a direct GitHub link for WebConsole, improving usability and clarity.

Low
Fix INSTALL-AGENT.md link to avoid Google search

Replace the Google search URL for INSTALL-AGENT.md with a direct relative link.
Using a Google search link for a local file is incorrect and will not work properly.

examples/openclaw-memory-plugin/INSTALL.md [329]

-**See also:** [INSTALL-ZH.md](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-memory-plugin/INSTALL-ZH.md) (Chinese) · [INSTALL-AGENT.md](https://www.google.com/search?q=./INSTALL-AGENT.md) (Agent Install Guide)
+**See also:** [INSTALL-ZH.md](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-memory-plugin/INSTALL-ZH.md) (Chinese) · [INSTALL-AGENT.md](./INSTALL-AGENT.md) (Agent Install Guide)
Suggestion importance[1-10]: 4

__

Why: Replaces an incorrect Google search URL with a direct relative link for INSTALL-AGENT.md, fixing the broken link.

Low
General
Fix code block language for shell commands

Change the code block language from python to bash since the content consists of
shell commands, not Python code. This ensures proper syntax highlighting and avoids
confusion.

examples/openclaw-memory-plugin/INSTALL.md [184-188]

-```python
+```bash
 npm install -g openclaw-openviking-setup-helper
 ov-install
<details><summary>Suggestion importance[1-10]: 3</summary>

__

Why: Corrects the code block language from `python` to `bash` for shell commands, ensuring proper syntax highlighting and avoiding confusion.


</details></details></td><td align=center>Low

</td></tr></tr></tbody></table>

@qin-ctx qin-ctx merged commit 06f2602 into main Mar 16, 2026
2 checks passed
@qin-ctx qin-ctx deleted the yuyaoyoyo-svg-patch-6 branch March 16, 2026 11:40
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenViking project Mar 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants