support icon indicating copy to clipboard operation
support copied to clipboard

Docs needs better clarification of npm install

Open andymcloid opened this issue 1 month ago • 2 comments

Summary

Bryntum’s “Get Started” pages should include the required npm configuration alongside the installation step.

Problem Statement

The quick-start guides show how to install packages using npm install, but this command fails unless the Bryntum npm configuration has already been set up. That information is located on a different page and is easy to miss for both developers and AI tools, leading to unnecessary installation errors.

Proposed Solution

Add a short note or section directly next to the npm install step explaining that some npm configuration is required beforehand, and link clearly to the relevant documentation. The goal is for all essential steps to be discoverable on the same page.

Alternatives Considered

Expecting users to find the NPM Repository page on their own (works but often overlooked). Assuming AI tools will detect the missing configuration (does not work in practice)

Additional Context

Both developers and AI assistants follow quick-start guides linearly. Without the configuration information at the installation step, onboarding breaks early for no good reason.

andymcloid avatar Nov 14 '25 09:11 andymcloid

ping @matsbryntse

andymcloid avatar Nov 14 '25 09:11 andymcloid

Hi @andymcloid 👋

Image

Thanks for the suggestion. We do have a section just before installation but I will make it more obvious with a note. so AI models don't miss it.

khattakdev avatar Nov 14 '25 10:11 khattakdev