Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Generate hash for index.json requests (FSharp.Formatting issue)

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

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
fsharp, javascript
领域
documentation

调研方向

从第 14 行的 docs/content/fsdocs-search.js 开始,跟踪生成 index.json 和生成的资源 URL 的模板处理路径。确定生成的链接以及 CSS 或脚本引用是如何生成的;完成标准是更新后的内容获得一个哈希查询值,使浏览器不会重用过时的 index.json 响应。

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

描述

fsdocs

The index.json search index cached by browsers may become out of date as the site gets refreshed

This is an FSharp.Formatting issue (specifically in fsdocs-search.js) noted by @baronfel in https://github.com/fsharp/fsharp-core-docs/pull/27#issuecomment-667561113

Cool. How do we check that? Here's the request: fsprojects/FSharp.Formatting@master/docs/content/fsdocs-search.js#L14

Regarding this point, I'd suggest that that content rendered by the templating engine render the content, and provide a hashed value for this specific content

Then, when rendering links/src elements to generated content files, append the hash to the query string. This would mean that urls like the one in the search JS you linked would need to be templated as well. Same for css links in the html head elements, etc.

主要语言
没有语言数据
星标
37
派生
20
平均合并
5 分钟
30 天内合并 PR
2

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

fsharp/fsharp-core-docs 的其他 Issue

查看 fsharp/fsharp-core-docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

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