Skip to content

Add contextual guidance to canvas Help and dynamic resource link - #86

Open
mniinio wants to merge 1 commit into
mainfrom
codex/review-context-handling-on-method-pages
Open

Add contextual guidance to canvas Help and dynamic resource link#86
mniinio wants to merge 1 commit into
mainfrom
codex/review-context-handling-on-method-pages

Conversation

@mniinio

@mniinio mniinio commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Motivation

  • Improve context handling by showing method-specific guidance when a canvas is selected so users get immediate, localized purpose and usage tips.
  • Make the top-brand link and help actions point to the currently selected canvas method page instead of always linking to a single resource.

Description

  • Replace the static brand link and expose the brand element as this.brandLink, and compute a resourceSlug from contentData.templateId to point the brand to https://www.apiopscycles.com/resources/<slug>/ and set an aria-label accordingly.
  • Add updateContextualContent() which reads localizedData for the current contentData and prepends a .cc-help__context section to the Help panel containing the localized title, purpose, and howToUse, plus a method page link; call it from render() and renderHelp().
  • Add CSS rules for .cc-help__context in styles/canvascreator.css to visually separate the contextual help block.
  • Add a focused UI test in tests/initCanvasCreator.test.js that verifies the Help context content and the brand link update when switching canvases/locales.
  • Document the user-facing change under an Unreleased section in CHANGELOG.md.

Testing

  • Ran the focused unit test with npx jest tests/initCanvasCreator.test.js --runInBand, and it passed.
  • Ran the full test suite with npm test -- --runInBand, and all test suites passed (14 suites, 52 tests).
  • Built and validated artifacts with npm run build and npm run minify-css, and both succeeded.

Codex Task

@netlify

netlify Bot commented Jul 26, 2026

Copy link
Copy Markdown

Deploy Preview for apiops-cycles-canvascreator ready!

Name Link
🔨 Latest commit 2fdf0bd
🔍 Latest deploy log https://app.netlify.com/projects/apiops-cycles-canvascreator/deploys/6a65c6cac5d3ef00082926be
😎 Deploy Preview https://deploy-preview-86--apiops-cycles-canvascreator.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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant