helpers icon indicating copy to clipboard operation
helpers copied to clipboard

Write a blog entry for hcache_simple.py, hcache.py

Open gpsaggese opened this issue 6 months ago • 9 comments

gpsaggese avatar Jun 03 '25 14:06 gpsaggese

  • [x] The first step here is to carefully document cache and cache_simple with our Diataxis approach.
    • [x] cache_simple
    • [x] cache
  • [ ] Add the architecture info on the white paper
  • [ ] Extract a blog from the documentation and publish

gpsaggese avatar Jun 17 '25 13:06 gpsaggese

@gpsaggese Should i rewrite the documentation for cache, cache_simple ?

srinivassaitangudu avatar Jun 18 '25 15:06 srinivassaitangudu

What does "rewrite" mean?

We already have some docs

> ffind.py cache | grep md
./docs/tools/helpers/all.hcache_simple.explanation.md
./docs/tools/helpers/all.hcache.explanation.md

so we need to ensure they are current and see if we can improve them.

Let's focus on simple cache first.

gpsaggese avatar Jun 19 '25 18:06 gpsaggese

I have made few improvements to ./docs/tools/helpers/all.hcache_simple.explanation.md, please have a look #862

srinivassaitangudu avatar Jun 20 '25 12:06 srinivassaitangudu

@gpsaggese Directly copy-pasting documentation into a blog may feel a bit dry or documentation-heavy to external readers.

I’d like to propose lightly adapting the structure to fit a blog format — without changing the content itself. The goal is to preserve all technical accuracy, but present it with a more engaging tone.

For example:

  • Add a 1-paragraph intro before the “Overview”
  • "Why we built 'hcache_simple'?"(will cover the problem/motivation)
  • Rewording some headers like Common Misunderstandings -> Gotchas to Watch out for

These small changes can make it more approachable and also being consistent with the documentation.

Or we can go ahead with copy-pasting for now, and later explore a structured approach to adapt the documentation for blog formats more efficiently.

srinivassaitangudu avatar Jun 20 '25 13:06 srinivassaitangudu

I'm putting together some guidelines, but in few words we are trying to:

  1. The blog and the doc are the same
  2. It's optimized for consumption (e.g., bullet points, and no fluff)

gpsaggese avatar Jun 20 '25 16:06 gpsaggese

@gpsaggese I have made changes to ./docs/tools/helpers/all.hcache.explanation.md, please review #868.

srinivassaitangudu avatar Jun 20 '25 21:06 srinivassaitangudu

[]  Add the architecture info on the white paper

@gpsaggese Both hcache_simple and hcache docs include execution flow diagrams—do you think those sufficiently cover the architecture, or were you thinking of something more detailed or different?

srinivassaitangudu avatar Jun 23 '25 16:06 srinivassaitangudu

Can you pls check with your tech lead from https://docs.google.com/document/d/1JJWUBo6Qk1FC4s2GJx2nObAGpA8L_bWOLW6dWt9LMhY/edit?tab=t.bjw7sthewc31 ?

gpsaggese avatar Jun 26 '25 12:06 gpsaggese