LearnNewsExamplesServices
Frontmatter
id7301
titleAdd Intent-Driven JSDoc to `splitter.MainContainer` Example
stateClosed
labels
documentationhelp wantedgood first issuehacktoberfest
assigneesnikeshadhikari9
createdAtSep 28, 2025, 3:34 PM
updatedAtOct 1, 2025, 10:04 AM
githubUrlhttps://github.com/neomjs/neo/issues/7301
authortobiu
commentsCount6
parentIssue7296
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtOct 1, 2025, 10:04 AM

Add Intent-Driven JSDoc to splitter.MainContainer Example

Closed v11.0.0 documentationhelp wantedgood first issuehacktoberfest
tobiu
tobiu commented on Sep 28, 2025, 3:34 PM

The existing example for Neo.component.Splitter at examples/component/splitter/MainContainer.mjs is not easily discoverable by our AI query tool because it lacks descriptive JSDoc comments.

The goal of this ticket is to add high-quality, intent-driven documentation to this file, making it a more valuable resource for both human developers and our AI agent.

Tasks:

  1. Open the file examples/component/splitter/MainContainer.mjs.
  2. Add a class-level JSDoc comment explaining that this view is an example to demonstrate the splitter component.
  3. Add descriptive JSDoc comments to each method (createConfigurationComponents, createExampleComponent, logInstance, switchDirection), explaining its purpose and parameters.
  4. Use src/core/Base.mjs as a reference for high-quality, intent-driven JSDoc style.
tobiu added the documentation label on Sep 28, 2025, 3:34 PM
tobiu added the help wanted label on Sep 28, 2025, 3:34 PM
tobiu added the good first issue label on Sep 28, 2025, 3:34 PM
tobiu added the hacktoberfest label on Sep 28, 2025, 3:34 PM
tobiu added parent issue #7296 on Sep 28, 2025, 3:34 PM
nikeshadhikari9
nikeshadhikari9 Sep 29, 2025, 11:09 AM

Hi, I have recently known and started writing JSDoc based comments with docdash theme for my personal projects and would be great If I could know more about the intent-driven JSDoc style from the existing comments from src/core/Base.mjs file and would love to contribute to write similar intent-driven JSDoc style comment to examples/component/splitter/MainContainer.mjs file.

Could you please assign this documentation issue to me? I’d be happy to submit a PR with the updated comments.

nikeshadhikari9 cross-referenced by #7299 on Sep 29, 2025, 11:37 AM
tobiu
tobiu Sep 29, 2025, 11:41 AM

Sure, and thanks for your interest! Hint: do not submit PRs before October 1, to ensure they count for the Hacktoberfest event.

I just finished: https://github.com/neomjs/neo/blob/dev/.github/WORKING_WITH_AGENTS.md

Which relates to: https://github.com/neomjs/neo/blob/dev/.github/AI_QUICK_START.md

While the task can be easily done manually, I encourage you to try out the new "AI Native" workflows.

tobiu assigned to @nikeshadhikari9 on Sep 29, 2025, 11:41 AM
nikeshadhikari9
nikeshadhikari9 Sep 29, 2025, 2:37 PM

Thank you for the advice, I will surely go through the both readme's and try to use the AI Native workflows.

tobiu
tobiu Sep 29, 2025, 3:51 PM

You are welcome. Let me explain my own rationale a bit: It has definitely taken me longer to craft the intro ticket and subs, than it would have taken to just tell Gemini to resolve the tasks.

So, my goal is not to just delegate work, but to enable others to learn something new on the way. Since you mentioned that that you looked at core.Base: You will most likely agree, that it takes a lot of cognitive load to even understand parts of it. And yet, the class config system (combined with the Neo.mjs file) enables us to do great things.

Bigger picture: my goal is to enable others to get the most out of multi-threaded frontend development, without the need to fully understand the internal mechanics => making the platform/framework more accessible and approachable.

nikeshadhikari9
nikeshadhikari9 Sep 29, 2025, 4:33 PM

That makes a lot of sense, and I really appreciate your approach! I can see how the goal is not just to get things done, but to make the learning journey meaningful for everyone involved. I agree that understanding core.Base and the class config system takes a lot of mental load, but it’s amazing how it enables so much flexibility and power.

Also as you advised I was trying out the "AI Native" worflow, I stumbled upon the installation of google gemini cli and found out the package name was bit off in https://github.com/neomjs/neo/blob/dev/.github/AI_QUICK_START.md

Currently it is: npm i -g @google/generative-ai/cli

It should have been: npm i -g @google/gemini-cli

Would it be okay if I update this in my next PR?

tobiu
tobiu Sep 29, 2025, 4:44 PM

Thanks for the heads up! Normally I would recommend to open a ticket (please do in the future!), but since this item affects to hacktoberfest onboarding experience for others, I will change & push it right away.

There is a Slack & a Discord Channel posted inside the parent ticket, in case you prefer a more direct communication (e.g. for asking questions).

tobiu referenced in commit 4b6a979 - "AI_QUICK_START.md: fixed the gemini cli installation path. thx for the heads-up! #7301" on Sep 29, 2025, 4:46 PM
nikeshadhikari9 cross-referenced by PR #7313 on Oct 1, 2025, 8:32 AM
tobiu closed this issue on Oct 1, 2025, 10:04 AM