Repository navigation
docs: show the GitHub Action and a safe preview first, with links that work on npm - #56
Conversation
…d use absolute links for npm
|
Warning Review limit reachedNext included review available in 29 minutes. View limit detailsLimit 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. Review configuration: ⚙️ Run configurationConfiguration used: Repository: GeiserX/ghost-github-portfolio/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (4)
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. Comment |
|
@coderabbitai review |
|
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-outpreview, with writing to Ghost as the next step. The scheduling page gets theuses:block with its inputs fromaction.yml. The LICENSE links are absolute, the badges follow the standard order, the two preview screenshots move todocs/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.jsonand the lockfile.No workflow is touched. The npm publish fix is in #55.