Skip to content

docs: update main readme and dev docs#34

Merged
nicomiguelino merged 4 commits intoScreenly:masterfrom
nicomiguelino:update-readme
Feb 27, 2025
Merged

docs: update main readme and dev docs#34
nicomiguelino merged 4 commits intoScreenly:masterfrom
nicomiguelino:update-readme

Conversation

@nicomiguelino
Copy link
Copy Markdown
Collaborator

Description

  • Updates styling of headers and badges in README.md
  • Added a link to the official Zapier Screenly integration
  • Updated developer docs

Checklist

  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation (where applicable).
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copilot AI review requested due to automatic review settings February 27, 2025 21:57
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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

@nicomiguelino nicomiguelino merged commit 7d94f2a into Screenly:master Feb 27, 2025
2 checks passed
@nicomiguelino nicomiguelino deleted the update-readme branch February 27, 2025 22:07
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.

2 participants