feat: create docs-v2 structure with diataxis framework#906
Conversation
1c94a9a to
06a2702
Compare
|
Instead of having a persistent tab bar, could we (1) use the logo as the link to the "Overview" page, and (2) put the "Documentation" and "Community" links in the top nav bar? Also, I feel like the sidebar for the Documentation tab is a bit overwhelming, as in "What is all this? Where am I supposed to look?" The |
996b289 to
170ad13
Compare
06a2702 to
a668530
Compare
170ad13 to
24ac67f
Compare
a668530 to
7af1855
Compare
- Create new docs-v2 directory with modern docs.json configuration - Implement 3-tab navigation: Overview, Documentation, Community - Structure Documentation section following diataxis framework: - Tutorials (learning-oriented) - Learn/Explanations (understanding-oriented) - How-to Guides (task-oriented) - Reference (information-oriented) - Add 44 stub files for team members to populate - Update package.json with docs-v2 scripts - Use modern docs.json format with proper tabs support 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
7af1855 to
3b2cef6
Compare
Thanks! Good ideas, will check if this is possible with Mintlify. Also this is still very much a placeholder, definitely not final. Just creating this for folks to "work into" sooner rather than later. |
|
@jonathanhefner I had a look and unfortunately it looks like the Also, with the proposal to have |
It seems like that might a bug in the
Perhaps we could submit a ticket to Mintlify. (I would recommend an Anthropic employee be the one do so; the last time I submitted a ticket on Anthropic's behalf, customer support suggested incorrect solutions, and then closed the ticket when I requested escalation.) As a workaround we could hard code the domain as |


Motivation and Context
New structure for v2 of our docs. The docs page itself has placeholders.
Outstanding: add the spec + versions to this current version (on me)
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com
How Has This Been Tested?
npm run serve:docs-v2Breaking Changes
None.
Types of changes
Checklist
Additional context