Draft
Conversation
Deeply analyzed the Knock docs structure and content against the Diátaxis documentation framework (https://diataxis.fr/). The analysis maps every major docs section to Diátaxis quadrants, identifies key gaps and misalignments, and provides 8 high-priority actionable recommendations with implementation priority rankings. Co-authored-by: Chris Bell <chris@cjbell.co>
|
Cursor Agent can help with this pull request. Just |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: Chris Bell <chris@cjbell.co>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a comprehensive analysis of our existing documentation structure and content against the Diátaxis framework. The goal is to identify areas where our documentation can be improved to better serve different user needs (tutorials, how-to guides, reference, and explanation).
The analysis, contained in
DIATAXIS_ANALYSIS.md, details current state mapping, key findings, and 8 prioritized recommendations for enhancing clarity, discoverability, and overall user experience.Todos
Tasks
This PR directly addresses the request to "deeply analyze our docs structure and contents against [Diátaxis] and recommend 5-10 high priority actionable changes."
Screenshots