processing / processing/processing-website

Adding "Go to source" link to reference pages

未关闭
#704 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
MDX
星标
90
派生
122
平均合并
1 小时 43 分钟
30 天内合并 PR
3

描述

Which area of the website does this enhancement relate to?

Reference

Describe the enhancement

Reference pages don't have any reference, connecting them to their source version in this repo. Let's say you want update a reference page, or simply fix a typo: https://processing.org/reference/frameCount.html While the change is only a single letter, because the website has no reference to https://github.com/processing/processing-website/blob/1fce63d07182becca614b95ab76b3b1416424d8d/content/references/translations/en/processing/frameCount.json , one should learn where the content is kept and search for the content in the repo.

Why is this enhancement important?

The lack of direct connection the presentation and source layer for reference docs makes the contribution process harder.

Additional context

No response

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 frameCount 的参考页面及对应的 content/references/translations/en/processing/frameCount.json 文件开始。跟踪参考页面的呈现方式,然后确定源链接应放置的位置;当参考页面提供指向此仓库中其源内容的直接链接时,工作就完成了。

由索引模型根据 Issue 内容生成。

评估

领域
documentation
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
活跃
描述清晰度
基本清楚
新手友好度
72/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。