LearnNewsExamplesServices
Frontmatter
title#7418 Refine and Integrate GitHub CLI Guide
authorMahita07
stateMerged
createdAtOct 9, 2025, 2:54 PM
updatedAtOct 9, 2025, 9:03 PM
closedAtOct 9, 2025, 9:03 PM
mergedAtOct 9, 2025, 9:03 PM
branchesdev ← refine-gh-cli-guide
urlhttps://github.com/neomjs/neo/pull/7427
Merged
Mahita07
Mahita07 commented on Oct 9, 2025, 2:54 PM

Please make sure to read the Contributing Guidelines:

https://github.com/neomjs/neo/blob/dev/CONTRIBUTING.md

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe: documentation

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the main branch
  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

Other information: This PR contains the changes required to refine the GitHub CLI setup guide by:

  • Move the guide from learn/guide/development to learn/guide/ai
  • Add an entry for the guide in learn/tree.json
  • Adding a section with about adding instructions about .env
  • Reference the guide's new location in AGENTS.md
Mahita07
Mahita07 commented on Oct 9, 2025, 3:00 PM

@tobiu Could you please review this PR ? Also I tried verifying by following the steps mentioned in the issue here, but the UI seems to be broken as shown in the attached screenshot. Not sure how to fix this.

image

tobiu
tobiu commented on Oct 9, 2025, 9:02 PM

thx for your contribution! regarding your comment: oh no, then you were not able to open any demo app or examples locally. for issues like this, best ping me on slack / discord to get input faster.

the good news: super easy to resolve. the initial theme build is just missing. my recommendation is to use npm run build-all, since this one also includes parsing src files to extract meta-infos like comments. optional: afterwards you can ask gemini to re-create the ai knowledge base, and from there it can give you way better input.

pr review from gemini:

✦ I've reviewed the diff against the ticket requirements, and this is another excellent pull request.

Review:

  • Task 1 (Move Guide): The diff clearly shows the file was moved from learn/guides/development/GitHubCLISetup.md to learn/guides/ai/GitHubCLISetup.md. Passed.
  • Task 2 (Update Navigation): The new entry for "GitHub CLI Setup" has been correctly added to learn/tree.json under the guides/ai parent. Passed.
  • Task 3 (Update Guide Content): A new section explaining how to use the .env file for the GH_TOKEN has been added to the guide. The added content is clear and helpful. Passed.
  • Task 4 (Update AGENTS.md): The link to the guide within AGENTS.md has been updated to the new path. Passed.

Conclusion: All acceptance criteria have been met perfectly. This PR is ready to be merged.

My review comment for the PR will be:

This is a perfect PR, great job! All requirements from ticket #7418 have been met.

  • The guide has been moved to the correct learn/guides/ai/ directory.
  • The learn/tree.json navigation file has been updated correctly.
  • The guide itself has been enhanced with clear instructions on using the .env file for the GH_TOKEN.
  • The reference in AGENTS.md has been updated to the new file path.

This is a solid contribution that improves the project's documentation and structure. Merging now.