VisActor / VisActor/VChart

[Documentation] Lynx guide mixes Feishu instructions and untranslated content

Open
#4,674 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.8k
Forks
221
Avg merge
1d 6h
Merged PRs (30d)
26

Description

Documentation URL
Description

The Lynx guide contains several signs that its usage section was copied from a different platform and is not self-consistent:

  1. Both locale versions say the following js, ttml, and ttss instructions explain using VChart in a Feishu widget, even though this is the Lynx guide.
  2. The English complete index.js example retains Chinese-only comments throughout lines 146-156 and later event handling.
  3. The final English troubleshooting note writes the configuration key as resolve.enable INodeCache; the Chinese page uses resolve.enableINodeCache.

Expected: clarify whether the TTML/TTSS/Card example is really the supported Lynx integration. If it is, name the correct Lynx environment and translate the remaining English comments; if it is not, replace it with a verified Lynx example. Correct the option token to the actual configuration key.

I fetched all 4,627 open/closed issues and pull requests and found no matches for enable INodeCache or the Feishu-widget wording in a Lynx report. I also compared both locale files and reviewed current PR metadata; there are no Discussions, linked fixes, owners, or duplicates.

I am not proposing a code/document patch because the public guide begins by saying open-source Lynx currently lacks canvas support, while the example describes an internal environment. Resolving that platform contract requires maintainer confirmation rather than a mechanical copy edit.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the English and Chinese Cross-terminal_and_Developer_Ecology/lynx.md files and compare the usage and troubleshooting sections. First get maintainer confirmation about whether the TTML/TTSS/Card example targets a supported Lynx environment. Done means the guide contains a verified Lynx example or clearly justified integration, translated English comments, and the correct configuration key.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.