Skip to content

Mw add learn card#66

Merged
themattwilliams merged 6 commits intomainfrom
mw-add-learn-card
Aug 12, 2025
Merged

Mw add learn card#66
themattwilliams merged 6 commits intomainfrom
mw-add-learn-card

Conversation

@themattwilliams
Copy link
Copy Markdown
Contributor

@themattwilliams themattwilliams commented Aug 5, 2025

What/Why/How?

What

  • Added a new API Testing learning center card with streamlined index page
  • Created /learn/testing section with hub-style navigation to existing resources
  • Updated content structure to point to relevant Arazzo and contract testing articles

Why

  • Fill content gap: API testing is a core competency but lacked a dedicated learning hub
  • Support product adoption: Helps users discover and navigate to Redocly's testing-related content
  • Improved discoverability: Creates a central entry point for API testing resources
  • Better user experience: Simplified navigation with FAQ-style structure

How

  • Hub-and-spoke approach: Created index page that points to existing high-quality content
  • Content consolidation: Removed placeholder articles, kept proven educational content
  • Integration: Updated learning center cards.ts to surface testing content prominently
  • User-friendly design: FAQ format with annotated links and multiple CTAs

Reference

Files Created/Modified:

  • pages/learning-center/cards.ts - Added API Testing card (id: 5)
  • learn/testing/index.md - Hub page with FAQ-style navigation
  • learn/testing/sidebars.yaml - Updated sidebar structure
  • Removed placeholder articles (best-practices.md, getting-started.md, etc.)

Content Structure:

Testing

Manual Testing Performed:

  • ✅ Local preview: Verified content renders correctly
  • ✅ Navigation: Confirmed links work to both internal and cross-section articles
  • ✅ Card integration: API Testing card appears in learning center with correct navigation
  • ✅ Content flow: Verified logical progression and clear CTAs

Additional Notes:
Please note, the current implementation focuses on creating a navigation hub that points to existing high-quality resources. The Contract Testing 101 article provides comprehensive foundational content, while the Arazzo testing article offers hands-on workflow testing guidance. This approach leverages existing proven content while creating better discoverability. Future targeted articles can be added to expand the section as needed.

@themattwilliams themattwilliams merged commit 7fe2875 into main Aug 12, 2025
4 of 5 checks passed
@themattwilliams themattwilliams deleted the mw-add-learn-card branch August 12, 2025 21:19
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.

2 participants