Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jamie-BitFlight merged 2 commits into from
Oct 10, 2026
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2ddfe4
docs: distinguish CLI and library entries after error boundary change
Jamie-BitFlight Oct 10, 2026
6b7124b
docs: render CLI and library source entries on separate lines
Jamie-BitFlight Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ npm run generate-docs # regenerate README.md from action.yml

```text
src/
index.ts CLI entry point
cli.ts CLI error-reporting entry point (dist/bin/index.js)
index.ts library entry point (dist/mjs/index.js); retains import-time generation
Action.ts action.yml metadata parsing
inputs.ts Inputs class: CLI args -> .ghadocs.json -> action.yml cascade
readme-generator.ts ReadmeGenerator class - generate()/updateSections()/outputSections()
Expand Down
Loading