大家好!我是Reddit新手,我刚刚开始在Reddit上构建项目。我是通过寻找“Reddit API”而来到App快速入门指南(Getting Started)指南的。作为一个完全的新手,我尝试遵循它并想分享三个让我感到困惑的地方,另外一个具体的建议来修复其中一个问题。希望这能帮助文档团队!
我遵循的文档是:https://developers.reddit.com/docs/quickstart
困惑1 - “大约1分钟即可完成”估计。
介绍说教程“应该花费大约1分钟”完成。但是,实际步骤包括安装Node.js和NPM,创建Reddit账号,通过OAuth向导,安装依赖项。对于一个初学者,这是轻松15到30分钟,而不是1分钟。估计不准确让我认为我卡住了或做错了什么。
困惑2 - 未定义的术语和不清晰的范围(Devvit vs. Reddit API)。
作为一个寻找“Reddit API”的人,我无法确定什么是“Devvit”实际上是什么 versus经典Reddit REST API。单词“Devvit”出现在每个地方,但在这个页面上从未定义。同样,“Playtest”、“开发子版块”和“后端函数/调用”- 他们被使用但没有一行定义或链接。 我不知道Devvit是API,包装器,CLI还是托管平台。
困惑3 - “环境设置”部分的空白和排序问题(网页向导到终端)。
步骤2将我带到一个网站(developers.reddit.com/new)去“选择React模板”,但步骤4突然说“遵循您的终端中的指示”,并且成功输出显示本地文件和一个“cd my-app”命令。从未解释过如何将项目下载到我的机器上,需要运行哪个命令,或者是否需要在本地安装CLI。没有可复制和粘贴的命令来完成最重要的步骤:创建项目。
我的具体建议(修复困惑3):
在“环境设置”部分中添加一个明确的,可复制和粘贴的代码块并清晰地解释网页到终端的转换。例如:
步骤1,检查Node版本(必须是24.18.0+):
node --version
步骤2,安装Devvit CLI:
npm install -g devvit
步骤3,登录并从模板创建应用:
devvit login
npm create devvit@latest my-app
步骤4,进入项目并开始开发:
cd my-app
npm run dev
我还会添加一个澄清的句子,如:“网页向导在developers.reddit.com/new生成一个命令 - 复制并粘贴到您想创建项目的文件夹中。”对“Playtest”有一个简短的定义,并添加一行注释来说明Devvit与经典Reddit API之间的关系会对新手有很大的帮助。
感谢您建立这个平台。平台看起来很棒;我只是想让初学者上路更平滑。
评论 (0)