Skip to content
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.

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

docs: refactor README #60

Merged
merged 8 commits into from
Dec 5, 2024
Merged

docs: refactor README #60

merged 8 commits into from
Dec 5, 2024

Conversation

tyler36
Copy link
Collaborator

@tyler36 tyler36 commented Dec 3, 2024

The Issue

A recently issue on Discord raised some areas for improvement in the currently documentation.

Overview by @rfay:

I do think we should add:

  • No gateway/502 might mean you haven't done ddev browsersync
  • How to add a config.browsersync_extras.yaml that adds web_extra_daemons to auto start

The documentation is little fragmented and immature. As one fo the first addons created, it has not benefited from recent styles and trends in the addon community.

How This PR Solves The Issue

This PR is a comprehensive refactor of the README.MD.
It

  • standardizes Browsersync brand name
  • simplifies "Getting Started"
  • consolidates snippets into a "Intergration" section
  • expands and consolidates a "Troubleshooting" section
  • adds a snippet for auto-starting Browsersync

Manual Testing Instructions

Automated Testing Overview

Related Issue Link(s)

Fixes #3

Release/Deployment Notes

@tyler36 tyler36 changed the title docs: add "auto-start" section docs: refactor README Dec 3, 2024
@tyler36 tyler36 requested a review from rfay December 4, 2024 01:11
Copy link
Member

@rfay rfay left a comment

Choose a reason for hiding this comment

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

Looks great to me. Thanks for all your work on this!

README.md Outdated Show resolved Hide resolved
@tyler36 tyler36 merged commit 85e12b4 into ddev:main Dec 5, 2024
2 checks passed
@tyler36 tyler36 deleted the docs-refresh branch December 5, 2024 00:40
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.

feat: add browsersync helper
2 participants