Skip to content

docs: update CLI and library entrypoint guidance (#670) - #730

Merged
Jamie-BitFlight merged 2 commits into
mainfrom
docs/670-update-entrypoint-guidance
Oct 10, 2026
Merged

Jamie-BitFlight merged 2 commits into
mainfrom
docs/670-update-entrypoint-guidance

Conversation

@Jamie-BitFlight

Copy link
Copy Markdown
Contributor

Update AGENTS.md repository map after #725 introduced a separate CLI error boundary. The CLI entry source is src/cli.ts and still emits dist/bin/index.js; src/index.ts remains the library entry. Remove the obsolete src/errors/ map entry following #719. No public README option or user-facing configuration documentation changes are necessary for the merged fixes. Verify markdown lint and CI.

@coderabbitai

coderabbitai Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 58 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: bitflight-devops/github-action-readme-generator/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 754960b0-5438-4bb6-9095-1c55c49d3807

📥 Commits

Reviewing files that changed from the base of the PR and between 40c9efd and 6b7124b.


📒 Files selected for processing (1)
  • AGENTS.md

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Jamie-BitFlight
Jamie-BitFlight marked this pull request as ready for review October 10, 2026 23:17
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-10T23:19:19.121281Z b2ddfe4 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@Jamie-BitFlight Jamie-BitFlight left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed b2ddfe4234ddaa512888f7a4911ed246f0d84625 against main 40c9efd1eec677f6bf024402459661741330233a.

The entry-point correction is necessary after #725: src/cli.ts supplies the CLI error boundary and emits dist/bin/index.js; src/index.ts remains the library entry with its existing import-time generation. I traced those statements to the current build configuration and entry sources. The only changed file is AGENTS.md.

One P3 documentation defect is attached inline: the two entries were joined with literal backslash-n text instead of a real line break. No implementation regression was found in this documentation-only diff. The PR description also mentions removing the errors-directory map entry, but the diff does not do that and src/errors/is-error.ts still exists; deleting ErrorType did not remove that directory.

Both Node check runs are red. The inspected Node 24 job fails vp check only on src/inputs.ts, inherited from main/#726, then skips tests, coverage, build and docs generation. This PR did not introduce that failure. The separate lint and third-party integration checks succeeded.

Correct the inline typo, incorporate the shared formatting repair, and verify the resulting head. This documentation change can remain independent of #729; there is no functional dependency between their diffs.

Comment thread AGENTS.md Outdated
@Jamie-BitFlight
Jamie-BitFlight merged commit 6fd3540 into main Oct 10, 2026
9 of 11 checks passed
@Jamie-BitFlight
Jamie-BitFlight deleted the docs/670-update-entrypoint-guidance branch October 10, 2026 23:57
@Jamie-BitFlight

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 2.0.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

@Jamie-BitFlight Jamie-BitFlight added the released This issue/pull request has been released. label Oct 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released This issue/pull request has been released.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant