Skip to content

Commit

Permalink
chore: fix img attribution in my intro blog post
Browse files Browse the repository at this point in the history
  • Loading branch information
quetzalliwrites authored Dec 14, 2021
1 parent e4a709f commit b78e121
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions pages/blog/changes-coming-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ In our case, we need to add...
- **Conceptual docs** that explain our spec terminology in more detail that include **engineering diagrams**: people often learn visually!
- **Many more tutorials**. _(i.e. Websocket tutorial)_
- **CLI docs** under a **Reference** content bucket.
- A **tools section**! Currently we have documentation for our tools in individual tools' GitHub repos, under a `/docs` directory. Those should still remain there and continue to be maintained, but they also need to be documented in our Docs in a less informal way that what you see in a `README`.
- A **tools section**! Currently we have documentation for our tools in individual tools' GitHub repos, under a `/docs` directory. Those should still remain there and continue to be maintained, but they also need to be documented in our Docs in a less informal way than what you see in a `README`.
- **Usecases** and **Troubleshooting Guides**, under a new _How-To_ section.


Expand All @@ -78,6 +78,7 @@ Why, you wonder?
It was important (and exciting!) to me to introduce best practices from the [Diátaxis Framework](https://diataxis.fr/) for our new content buckets.

![Diátaxis framework](/img/posts/changes-coming-docs/diataxis.webp)
> Photo from <a href="https://diataxis.fr/">Diátaxis</a> on <a href="https://diataxis.fr/">Diátaxis framework</a>
The Diátaxis engineering documentation system classifies content under 4 main _agnostic_ buckets. This approach for Information Architecture (IA) and User Flows in dev docs is currently upheld widely within the tech industry. _(i.e. One current live example is GatsbyJS, which also uses the Diátaxis system for their Dev Docs. If you want to see a longer list of companies using it, go over [here](https://diataxis.fr/adoption/).)_

Expand Down Expand Up @@ -141,9 +142,3 @@ Tag me in your AsyncAPI Doc PRs or [GitHub Discussions](https://github.com/async
I want and need to listen 👂🏽 to all of your perspectives and ideas. Please don't be shy to express to me what you think needs to be documented first or what is missing. 📝

There's a lot of good work ahead, but **you** determine _our content roadmap_ because the OSS community needs should always come first.✨




---
> Photo from <a href="https://diataxis.fr/">Diátaxis</a> on <a href="https://diataxis.fr/">Diátaxis framework</a>

0 comments on commit b78e121

Please sign in to comment.