bytedance/flowgram.ai

[Doc] Materials Documentations

Open

#494 opened on Jul 9, 2025

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (730 forks)github user discovery
documentationgood first issuehelp wanted

Repository metrics

Stars
 (8,111 stars)
PR merge metrics
 (PR metrics pending)

Description

选择一个物料 内的 WIP 文档，开始你的贡献吧～

建议贡献前可以在这个 issue 内回复一下～

如何贡献：

  1. 在 apps/docs/components/form-materials 中，新增物料的案例展示（参考 VariableSelector Stories）
  2. 撰写文档（参考 variable-selector.mdx，展示：VariableSelector 文档），文档中在案例展示章节引用刚才创建的 Story，同时尽量保证文档风格和整体章节设计一致
  3. 确保英文版中文版文档都完成撰写（可借助 AI 完成翻译）
  4. 运行 rush dev:docs 进行文档调试
  5. 提交 PR

This text is auto-translated: Select a WIP document in Materials and start your contribution~

It is recommended that you reply in this issue before contributing~

How to contribute:

  1. In apps/docs/components/form-materials, show the case of adding new materials (refer to VariableSelector Stories)
  2. Write a document (refer to variable-selector.mdx, display: VariableSelector Document), in the document, reference the Story just created in the case display chapter, and try to ensure that the document style is consistent with the overall chapter design**
  3. Ensure that the English and Chinese versions of the documents are completed (translation can be completed with the help of AI)
  4. Run rush dev:docs for document debugging
  5. Submit a PR

Contributor guide

Research direction
Select a WIP material document, create a Story component in the form materials directory, and write the documentation in both languages following the existing patterns.
Tech stack
typescriptreact
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75