docs: update main readme and dev docs#34
Merged
nicomiguelino merged 4 commits intoScreenly:masterfrom Feb 27, 2025
Merged
Conversation
There was a problem hiding this comment.
PR Overview
This PR updates the main README and developer documentation to improve visual styling and clarify the Zapier deployment process.
- Updated header formatting, logo sizing, and badge presentation in README.md
- Revised Zapier deployment instructions in docs/developer-documentation.md to streamline setup
Reviewed Changes
| File | Description |
|---|---|
| README.md | Reformatted header and adjusted logo image width and badge presentation. |
| docs/developer-documentation.md | Added a new section for Zapier deployment while removing older instructions. |
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
README.md:6
- Verify that using a percentage-based width for the logo ensures proper responsiveness and visual consistency across devices. Consider testing this change across major browsers to confirm it renders as intended.
<img src="assets/logo-full.svg" alt="Screenly for Zapier" width="90%">
docs/developer-documentation.md:161
- The updated deployment instructions only include 'zapier push' without referencing the initial setup commands (e.g., 'zapier login' and 'zapier register'). Clarify whether these initial steps are assumed to have been completed already or need to be executed for first-time deployments.
zapier push
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
README.mdChecklist