fsharp / fsharp/fsharp-core-docs

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

Open
#33 0 comments 0 reactions 0 assignees View on GitHub
fsdocs
Dominant language
No language data
Stars
37
Forks
20
Avg merge
6m
Merged PRs (30d)
1

Description

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.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with docs/content/fsdocs-search.js at line 14 and trace the templating path that emits index.json and generated asset URLs. Determine how generated links and CSS or script references are produced; done means refreshed content receives a hash query value so browsers do not reuse stale index.json responses.

Written by the indexing model from the issue text.

Assessment

Tech stack
fsharp, javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.