tags

“We got documentation feedback on…transferring wealth?”

29 June, 2023 | 2 min read

A few weeks ago, I was plugging away at something significant (read: procrastinating by looking for ways of automating some repetitive task in an inane way) when I heard the familiar "pop-pop-pop" notification from Slack. Like many of you, Slack sits permanently open on my machine, every ping like a mosquito needing to be swatted away. However, this one got my attention.

In our #docs-feedback channel, which we connected to the feedback component at the bottom of every docs page, a new message came through:

New feedback on this page: <company_redacted> Transfers | Wealth Docs

I'm relatively neurotic, so the spike in cortisol from a near panic attack was significant, as my first thought was that we'd been hacked. How? Rationality is absent in fight-or-flight mode. 🤷‍♂️

It quickly became clear this wasn't a malicious attempt at hijacking our component or site – rather, this was someone so happy with our docs that they decided to copy them verbatim, leading to their docs feedback arriving on our Slack channel. We were flattered, and it quickly became an internal joke.

Then, it happened again. With another company.

Flattered as we were, we couldn't have other sites' feedback clogging our channel or dragging our average down inflating our KPIs. To mitigate this, we introduced a tiny bit of logic that prevents the input from going through, if not from our domain. Could you bypass this and still hit our API? Of course, but please don't. You surely have better things to do.

Our philosophy on docs

As Hasura’s core is open source, so are our docs. We regularly receive contributions from you all (thanks for catching our spelling mistakes 😘). We are constantly improving our documentation to better serve you in building your projects and products.

As we're sure you know from regularly visiting the docs wiki as part of your morning ritual while drinking coffee, you're no doubt familiar with the core of the docs team's philosophy around documentation:

We hold a strict standard because we want to ensure our users can quickly find what they need, understand it because it's well-written, and get back to building with Hasura. 🚀

We see the popularity of our docs site as a template as an extension of that philosophy! And we want you to keep using the docs site as your starting point for your next project's documentation.

Get your own Hasura docs!

We have an easy one-liner below if you want to get started with our docs site. This command will clone the hasura/graphql-engine repo and then remove every folder except the most important. 😉

git clone --depth 1 --filter=blob:none --sparse https://github.com/hasura/graphql-engine.git && cd graphql-engine && git sparse-checkout init && git sparse-checkout set docs && find . -type f ! -path "./docs/*" -delete

Then, git init and have some fun building on top of our docs!

BONUS: Be on the lookout for our new v3-docs site…coming soon! And, yes: It will still be open sourced for your nitpicking pleasure. 🥳

❤️ Hasura Docs Team


Share this article
Subscribe IlluSubscribe Illu

Monthly product updates in your inbox. No spam.

Loading...