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

Update docs #1357

Merged
merged 13 commits into from
May 13, 2022
Merged

Update docs #1357

merged 13 commits into from
May 13, 2022

Conversation

joelhawksley
Copy link
Member

@joelhawksley joelhawksley commented May 12, 2022

This PR:

  1. Updates our docs for grammar and clarity.
  2. Updates our PR template, taking inspiration from the github template.
  3. Updates the Helpers docs based on notes from @kevin-j-m's RailsConf talk.
  4. Adds notes to the changelog about an open role at GitHub and our RailsConf happy hour ❤️

@joelhawksley joelhawksley requested review from Spone, dylanatsmith and a team as code owners May 12, 2022 13:18

```ruby
class UserComponent < ViewComponent::Base
include IconHelper
Copy link
Contributor

Choose a reason for hiding this comment

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

With this order flipping, you may want to define/introduce the IconHelper module in this section (as opposed to below in the helpers proxy recommendation).

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, yes! Thanks for catching this ❤️

Co-authored-by: Kevin Murphy <murphy.kevin.mail@gmail.com>
docs/CHANGELOG.md Outdated Show resolved Hide resolved

*Joel Hawksley*

* The ViewComponent team at GitHub is hiring! We're looking for a Rails engineer with accessibility experience: [https://boards.greenhouse.io/github/jobs/3802139]. Reach out to joelhawksley@github.com with any questions!
Copy link
Collaborator

Choose a reason for hiding this comment

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

@joelhawksley The link seems broken.

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like this is the active URL: https://boards.greenhouse.io/github/jobs/4020166

docs/guide/helpers.md Outdated Show resolved Hide resolved
docs/logo.md Outdated Show resolved Hide resolved
joelhawksley and others added 5 commits May 12, 2022 17:49
Co-authored-by: Dylan Smith <dylanatsmith@gmail.com>
Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>
Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>
@joelhawksley joelhawksley merged commit 0990d81 into main May 13, 2022
@joelhawksley joelhawksley deleted the update-docs branch May 13, 2022 12:11
claudiob pushed a commit to claudiob/view_component that referenced this pull request Dec 22, 2023
* clean up changelog grammar

* clean up gitignore

* grammar updates

* prefer including helpers over helpers proxy

* update PR template

* Add changelog entries

* tweak changelog

* introduce helper in first code block

Co-authored-by: Kevin Murphy <murphy.kevin.mail@gmail.com>

* Update docs/CHANGELOG.md

Co-authored-by: Dylan Smith <dylanatsmith@gmail.com>

* Update docs/guide/helpers.md

Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>

* Update CHANGELOG.md

* Update docs/logo.md

Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>

Co-authored-by: Kevin Murphy <murphy.kevin.mail@gmail.com>
Co-authored-by: Dylan Smith <dylanatsmith@gmail.com>
Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>
claudiob pushed a commit to claudiob/view_component that referenced this pull request Jan 3, 2024
* clean up changelog grammar

* clean up gitignore

* grammar updates

* prefer including helpers over helpers proxy

* update PR template

* Add changelog entries

* tweak changelog

* introduce helper in first code block

Co-authored-by: Kevin Murphy <murphy.kevin.mail@gmail.com>

* Update docs/CHANGELOG.md

Co-authored-by: Dylan Smith <dylanatsmith@gmail.com>

* Update docs/guide/helpers.md

Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>

* Update CHANGELOG.md

* Update docs/logo.md

Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>

Co-authored-by: Kevin Murphy <murphy.kevin.mail@gmail.com>
Co-authored-by: Dylan Smith <dylanatsmith@gmail.com>
Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>
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.

4 participants