From 999a9cd3f1f726201dc4abb47caf2a9d7073c1dd Mon Sep 17 00:00:00 2001 From: Ben Koshy Date: Thu, 21 Oct 2021 17:18:35 +1100 Subject: [PATCH 1/3] update: installation instructions ### Why this change? * To clarify installation instructions: Usage of Rails view helpers to render octicons are discouraged as per #674 - but legacy users might be confused as to how to make it work - given it worked previously. This PR seeks to address any doubts raised. I hope it is useful, if not feel free to close. rgds Ben --- docs/content/packages/ruby.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/content/packages/ruby.mdx b/docs/content/packages/ruby.mdx index db1e12ff4..5e18053ef 100644 --- a/docs/content/packages/ruby.mdx +++ b/docs/content/packages/ruby.mdx @@ -16,6 +16,8 @@ gem 'octicons' Then `bundle install`. +If using a framework like Rails, please follow the installation instructions outlined [here](https://primer.style/view-components/#installation). + ## Usage ```rb From 5246301f065741616703e47684b2819e91270469 Mon Sep 17 00:00:00 2001 From: Ben Koshy Date: Fri, 22 Oct 2021 07:32:03 +1100 Subject: [PATCH 2/3] Update docs/content/packages/ruby.mdx fix: links to make them more impactful as per the (Primer Accessibility Style Guide)[https://primer.style/design/accessibility/guidelines#links]. Co-authored-by: Ash Guillaume <10384315+ashygee@users.noreply.github.com> --- docs/content/packages/ruby.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/packages/ruby.mdx b/docs/content/packages/ruby.mdx index 5e18053ef..8ac360877 100644 --- a/docs/content/packages/ruby.mdx +++ b/docs/content/packages/ruby.mdx @@ -16,7 +16,7 @@ gem 'octicons' Then `bundle install`. -If using a framework like Rails, please follow the installation instructions outlined [here](https://primer.style/view-components/#installation). +If using a framework like Rails, please follow the [installation instructions](https://primer.style/view-components/#installation) in the [Primer ViewComponents](https://primer.style/view-components) documentation. ## Usage From 529d2559db14d308751c6b62660b9c57b33f3481 Mon Sep 17 00:00:00 2001 From: Jon Rohan Date: Fri, 22 Oct 2021 19:09:23 -0700 Subject: [PATCH 3/3] Create ten-toes-doubt.md --- .changeset/ten-toes-doubt.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/ten-toes-doubt.md diff --git a/.changeset/ten-toes-doubt.md b/.changeset/ten-toes-doubt.md new file mode 100644 index 000000000..a1289aa67 --- /dev/null +++ b/.changeset/ten-toes-doubt.md @@ -0,0 +1,5 @@ +--- +"@primer/octicons": patch +--- + +update: installation instructions