Skip to content

docs: show the GitHub Action and a safe preview first, with links that work on npm - #56

Merged
GeiserX merged 1 commit into
mainfrom
docs/readme-review-fixes
Sep 29, 2026
Merged

GeiserX merged 1 commit into
mainfrom
docs/readme-review-fixes

Conversation

@GeiserX

@GeiserX GeiserX commented Sep 29, 2026

Copy link
Copy Markdown
Owner

The README never said the repository is a GitHub Action, and its quick start wrote straight to a live Ghost page with no preview first. It is also republished on npm, where its two relative LICENSE links go nowhere.

The pitch now names the three ways to run it, and the quick start ends with an --html-out preview, with writing to Ghost as the next step. The scheduling page gets the uses: block with its inputs from action.yml. The LICENSE links are absolute, the badges follow the standard order, the two preview screenshots move to docs/images/screenshots/, the Documentation list follows the standard order with the roadmap as a note, and the license reads GPL-3.0-or-later in the README, package.json and the lockfile.

No workflow is touched. The npm publish fix is in #55.

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 29 minutes.

Check out review usage here.

View limit details

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

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

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: GeiserX/ghost-github-portfolio/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: b563ab77-821c-424a-84a1-073cbb890767

📥 Commits

Reviewing files that changed from the base of the PR and between 27301e0 and 3260b6d.

⛔ Files ignored due to path filters (3)
  • docs/images/screenshots/preview-desktop.png is excluded by !**/*.png
  • docs/images/screenshots/preview-mobile.png is excluded by !**/*.png
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • README.md
  • docs/how-it-works.md
  • docs/scheduling.md
  • package.json

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.

@GeiserX

GeiserX commented Sep 29, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@GeiserX
GeiserX merged commit 4efa4fd into main Sep 29, 2026
8 checks passed
@GeiserX
GeiserX deleted the docs/readme-review-fixes branch September 29, 2026 22:34
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.

1 participant