Skip to content

docs: modernize web-architecture.md by removing deprecated tools#240

Open
Slambot01 wants to merge 1 commit intosugarlabs:masterfrom
Slambot01:fix/update-web-architecture-tools
Open

docs: modernize web-architecture.md by removing deprecated tools#240
Slambot01 wants to merge 1 commit intosugarlabs:masterfrom
Slambot01:fix/update-web-architecture-tools

Conversation

@Slambot01
Copy link

This PR updates the web-architecture.md file to reflect current technical standards. The previous documentation referenced Volo and RequireJS, which are no longer the primary tools used in the Sugar platform.

Here, I am attaching the technical Proof for it:

1)Volo is Deprecated: Volo has not been maintained for several years and is incompatible with modern Node.js runtimes.

2)Codebase Reality: The core sugar-web repository utilizes package.json for dependency management and Gruntfile.js for automation, rather than volo.json.

3)Standardization: Modern Sugar tools, including the sugar-cli and Sugarizer, already follow the NPM and ES6 Modules workflow described in this update.

By removing these outdated references, we ensure a smoother onboarding experience for new contributors

@chimosky
Copy link
Member

It'll be great if you've contributed to the software that you're trying to change its documentation, it doesn't seem like you have so I don't think you should be changing that.

Volo is still referenced in package.json, except you're sure it's no longer used, in which case it wouldn't be referenced, then you should take a look at the repo.

I'm also curious what sugar-cli is, as you've referenced it.

@quozl
Copy link
Contributor

quozl commented Jan 21, 2026

Sugar CLI is part of the sugarcrm software product, which is not ours at all.

https://support.sugarcrm.com/documentation/sugar_developer/sugar_developer_guide_14.2/architecture/cli/

@Slambot01 please include the prompt to your AI in any pull request comment.

@Slambot01
Copy link
Author

Hey @chimosky, thanks for the feedback!

I reviewed the package.json and I see the volo block, but it isn't actually present in the dependencies or devDependencies. This means a standard npm install doesn't actually install the tool, yet src/web-activity.md still asks users to install a deprecated global version.

I also noticed that some libraries are duplicated; the volo block points to mustache v0.7.2 (purple circle), but the actual active dependency used by the project is v4.2.0 . In other files like Gruntfile.js, there isn't a single reference to volo in the build logic.

Regarding RequireJS, I see it is active in the devDependencies for the test suite, so I’ll revert that change and keep it in the docs. However, I’d still love to move forward with removing volo so the documentation matches the modern NPM/Grunt workflow we’re actually using.

About sugar-cli, I’ve rechecked it and realized it’s a community tool, not an official org repo. I’ll remove that reference to keep the documentation strictly official.

Please let me know your thoughts on this

Screenshot 2026-01-21 234247m Screenshot 2026-01-21 235014

@quozl
Copy link
Contributor

quozl commented Jan 21, 2026

Community tool? Where is this sugar-cli you are talking about?

@Slambot01
Copy link
Author

@quozl , I apologize for the confusion and the error in my research. I found the sugar-cli repository by creeperyang while searching for alternatives to Volo (https://github.com/creeperyang/sugar-cli). Because of the name 'sugar,' I mistakenly assumed it was a community-supported tool for this organization.
Regarding your request for the prompt to be completely honest, while researching modern alternatives to replace Volo, I used an AI assistant to find current community standards. the prompt was like give alternatives to volo and sugar-cli was popped. Because of the name and how it was presented, i assumed it was an official tool without double-checking the owner.

@quozl
Copy link
Contributor

quozl commented Jan 22, 2026

Thanks. That's interesting.

Do be cautious in your approach; as far as I can tell you have not contributed code to Sugarizer, Music Blocks, or the JavaScript activities in Sugar desktop. Each of these three have their own tool set. Trying to change that tool set by changing documentation for Sugar only does seem a bit backward; you've no credibility (no visible contribution), you've no audience (the developers are busy in their own repositories), and you haven't demonstrated the tool set in any way in the context of a repository that contains code.

Basically, it seems like you're smokin' something strange.

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.

3 participants