Skip to content

Conversation

@PupilTong
Copy link
Collaborator

  • add en/zh blog about web platform
  • update docs about the lynx-view element for web platform

Change-Id: I07af86b21f2da1a477404a73ccfa3f5888d32708

@netlify
Copy link

netlify bot commented Jul 10, 2025

Deploy Preview for lynx-doc ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit eb1ae27
🔍 Latest deploy log https://app.netlify.com/projects/lynx-doc/deploys/68ff189994f0dd000870e201
😎 Deploy Preview https://deploy-preview-248--lynx-doc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@PupilTong PupilTong force-pushed the p/hw/improve-web-doc branch from 3754296 to 6547ff6 Compare July 10, 2025 09:18
@PupilTong PupilTong requested a review from Copilot July 10, 2025 09:18
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a new blog post ("Intro to the Lynx's Web Platform") in both English and Chinese, updates the author list, and enriches the web integration guide with <lynx-view> documentation.

  • Added two new authors (haoyang.wang, aihao) for blog avatars
  • Updated both zh/en integration guides: renamed sections, added core dependency, and documented <lynx-view> properties/events/methods
  • Added the new blog files and updated blog indexes and metadata

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/components/blog-avatar/authors.json Add two new author entries
docs/zh/guide/start/fragments/web/integrating-lynx-with-web.mdx Rename section, fix link, add <lynx-view> docs
docs/en/guide/start/fragments/web/integrating-lynx-with-web.mdx Rename sections, grammar fixes, add <lynx-view>
docs/zh/blog/lynx-intro-to-web-platform.mdx Add new Chinese blog post
docs/en/blog/lynx-intro-to-web-platform.mdx Add new English blog post
docs/zh/blog/index.mdx Register new blog in Chinese index
docs/en/blog/index.mdx Register new blog in English index
docs/en/blog/_meta.json Add new blog slug to metadata array
cspell.json Add new author names for spell-check
Comments suppressed due to low confidence (3)

docs/zh/guide/start/fragments/web/integrating-lynx-with-web.mdx:14

  • The link to '快速开始' is missing a leading slash; it should be (/guide/start/quick-start) for consistency with other guides.
我们假设已经阅读并按照[快速开始](guide/start/quick-start)创建了一个 Lynx 项目。

docs/en/guide/start/fragments/web/integrating-lynx-with-web.mdx:53

  • Grammar: change 'a existing' to 'an existing'.
## 2. Integrate with a existing Web App

docs/en/guide/start/fragments/web/integrating-lynx-with-web.mdx:57

  • [nitpick] This sentence is unclear—consider rewriting to 'Configuration may vary for different bundlers.'
Configure may various for different bundlers

@PupilTong PupilTong moved this to In Progress in Lynx for Web Jul 10, 2025
```

#### updateGlobalProps

Copy link
Contributor

Choose a reason for hiding this comment

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


// ...existing code...

### `<lynx-view>` properties
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this be a standalone article? This article is included under integrate-with-existing-apps and is only for the quick-start


Required. Setting this property starts the rendering logic. Other properties must be set before `url` to take effect.

#### globalProps
Copy link
Contributor

Choose a reason for hiding this comment

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


#### updateData

See [Update Data](https://lynx.bytedance.net/api/lynx-native-api/lynx-view/update-data.html)
Copy link
Contributor

Choose a reason for hiding this comment

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

It is better to use a relative path, otherwise it will point to the English document


#### Uncaught SecurityError: Failed to construct 'Worker': Script at '...' cannot be accessed from origin '...'.

This error usually occurs when the worker script is not served from the same origin as the main page. Ensure that your worker script is accessible from the same domain, protocol, and port as your web application.
Copy link
Contributor

Choose a reason for hiding this comment

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

Chinese


#### overrideLynxTagToHTMLTagMap

Allows overriding the mapping from Lynx tags to HTML tags.
Copy link
Contributor

Choose a reason for hiding this comment

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

It needs to be explained that it must be a custom element


#### nativeModulesMap

Custom NativeModules.
Copy link
Contributor

Choose a reason for hiding this comment

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


#### url

Required. Setting this property starts the rendering logic. Other properties must be set before `url` to take effect.
Copy link
Contributor

Choose a reason for hiding this comment

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

No introduction to the meaning of url? It is the remote file path of Lynx Web Platform build artifact


#### customTemplateLoader

By default, the JSON file corresponding to the URL is loaded using `fetch` with GET. Assigning this property allows for a custom loading method.
Copy link
Contributor

Choose a reason for hiding this comment

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

It is better to use the build artifact instead of the JSON file

@PupilTong PupilTong force-pushed the p/hw/improve-web-doc branch 2 times, most recently from 18b8afd to e831f5d Compare July 14, 2025 03:45
* add en/zh blog about web platform
* update docs about the lynx-view element for web platform

Change-Id: I07af86b21f2da1a477404a73ccfa3f5888d32708
Change-Id: Icf1fa0b3b7e462d72904027c0d5fe8b15b645f74
@PupilTong PupilTong force-pushed the p/hw/improve-web-doc branch from ab517bf to d5b23d5 Compare October 27, 2025 06:59
@PupilTong
Copy link
Collaborator Author

/cherry-pick release/3.5, release/3.4

@github-actions
Copy link

✅ Cherry-pick operation is running! Check the progress in this action:

@github-actions
Copy link

❌ Cherry-pick operation did not create any PRs, please check if the target branches exist or if there are conflicts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

2 participants