top | item 42329426

(no title)

mopierotti | 1 year ago

I checked out your docs, and I agree that they flow very nicely! So often it seems that docs are either frustratingly vague to the point where it almost seems like the company is embarrassed to admit that their tool is a tool and not a "transformative synergy experience" (or similar nonsense), or docs immediately get overly specific without covering "why this product exists".

Minor note: The only thing in your docs that made me pause was the repeated use of "CDC", which I had to google the definition of. (For context, I have implemented "CDC" several times in my career, but wasn't familiar with the acronym)

discuss

order

_acco|1 year ago

Aye, thanks! That's very helpful to hear. I just cut back our use of the acronym a ton:

https://github.com/sequinstream/sequin/commit/28bfba603da6d2...

mdaniel|1 year ago

In case you weren't already aware, most markdown parsers support actual HTML tags in it, and there's <abbr title="change data capture">CDC</abbr> that allows being visually succinct, is a11y friendly, and in most browsers is visually distinct to prompt the user there's more content hidden in the hover or long-press

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ab...

I'm also aware of https://developer.mozilla.org/en-US/docs/Web/HTML/Element/df... but I think it has more nuance to it and for sure involves having a lot more supporting structure in the document

eightnoneone|1 year ago

You were _this_ close!

What’s a CDC?