Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 4, 2025

Assessment of Cloud and Kanvas documentation structure against Diátaxis framework principles.

Findings

Strengths:

  • Clear product separation (Cloud/Kanvas)
  • Hugo/Docsy conventions followed
  • Consistent frontmatter metadata

Gaps:

  • Content organized by feature rather than user workflow
  • Limited cross-product integration guides
  • Navigation weights may not reflect user priorities

Recommendations

  • User journey organization: Restructure around tasks (getting-started → concepts → how-to → reference → troubleshooting) vs product features
  • Progressive disclosure: Layer content depth by user experience level
  • Cross-linking: Add integration guides where Cloud/Kanvas workflows overlap
  • Navigation audit: Review page weights to surface high-priority content first

Suggested Structure

/cloud/ or /kanvas/
├── getting-started/     # Onboarding & tutorials
├── concepts/            # Explanatory content  
├── how-to/              # Task-based guides
├── reference/           # Technical details
└── troubleshooting/     # Problem resolution

Priority Actions

Priority Action
High Content audit, add getting-started tutorials
Medium Cross-product guides, internal linking
Lower API reference expansion, advanced tutorials
Original prompt

This section details on the original issue you should resolve

<issue_title>[Docs] Analyze current documentation information architecture</issue_title>
<issue_description>#### Current State
The Cloud and Kanvas documentation sets have been developed, but remain incomplete. As more effort is put into completing them, it's appropriate to stop, analyze, and assess whether the current information architecture is ideal or could be improved.

Task

  1. Perform such an assessment, make and justify recommended changes, if any.
  2. Read and consider the current outline and audience defined here - https://github.com/layer5io/docs?tab=readme-ov-file#layer5-documentation-structure

Contributor Guide and Resources

Comments on the Issue (you are @copilot in this section)

Custom agent used: Diátaxis Documentation Expert
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@netlify
Copy link

netlify bot commented Dec 4, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 99b56ec
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/6931243a99bef0000997bb7f
😎 Deploy Preview https://deploy-preview-868--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI changed the title [WIP] Analyze current documentation information architecture docs: Documentation information architecture assessment Dec 4, 2025
Copilot finished work on behalf of yi-nuo426 December 4, 2025 06:03
Copilot AI requested a review from yi-nuo426 December 4, 2025 06:03
@leecalcote leecalcote marked this pull request as ready for review December 4, 2025 06:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Analyze current documentation information architecture

3 participants