cloudflare-docs icon indicating copy to clipboard operation
cloudflare-docs copied to clipboard

[KV] Overhaul KV API docs

Open thomasgauvin opened this issue 1 year ago • 7 comments

#15814 since refactor

thomasgauvin avatar Aug 23 '24 21:08 thomasgauvin

@kodster28 can we fix the ai linter so it doesn't throw on "namespace"? KV namespaces is the official term

thomasgauvin avatar Aug 23 '24 21:08 thomasgauvin

@kodster28 why is ai linter saying wrangler should not be capitalized? It is capitalized everywhere else in docs and is a product https://developers.cloudflare.com/workers/wrangler/

thomasgauvin avatar Aug 23 '24 21:08 thomasgauvin

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2176c15
Status: ✅  Deploy successful!
Preview URL: https://e56b8266.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://thomasgauvin-kv-commands-ove-qo5u.cloudflare-docs-7ou.pages.dev

View logs

@thomasgauvin , I can help! (dev @ hyperlint)! I'll give you some instructions momentarily to quiet some of these. All alerts are controllable by you all, so this is all pretty natural for just getting the style guide introduced as you build up the vocabulary. Give me one moment and I'll edit this and provide some links!


edit:

Step 1 edit this file

Things to do in that file...

  • Wrangler - Right now, it has wrangler lower-cased and upper cased in the vocabulary So it doesn't know what should be done.
  • add the words namespace and serializable and boolean, lookups

Once you've done that, you can just ignore Resolve Conversation on those issues.

bllchmbrs avatar Aug 23 '24 22:08 bllchmbrs

@thomasgauvin , see comment above. Feel free to ping me with any other questions!

edit: btw hyperlint runs in apart on workers and uses KV. Love the product!

bllchmbrs avatar Aug 23 '24 22:08 bllchmbrs

@bllchmbrs thanks, I'll make sure these are added to our dictionary! I didn't expect y'all to hop on this thread, thanks again! 🙌

thomasgauvin avatar Aug 26 '24 13:08 thomasgauvin