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: Add "Adding an icon" docs and update Icon docs #2366

Merged
merged 5 commits into from
Feb 12, 2025

Conversation

chris-at-jobber
Copy link
Contributor

@chris-at-jobber chris-at-jobber commented Feb 7, 2025

Motivations

Our docs for Icon were heavily focused on construction, rather than usage patterns and best practices.

Too much writing, not enough guidance!
image

In addition, the technical steps to add an Icon to Atlantis were in a Confluence instance, while the design guidance for designing a new Icon was in Atlantis.

Changes

Added

  • Docs for adding an Icon
  • Moved technical construction notes to this doc as well
    image

Changed

  • Icon docs are now more visual
    image
  • Icon construction docs are also more visual
    image

Testing

Run docs site locally


In Atlantis we use Github's built in pull request reviews.

Random photo of Atlantis

Copy link

cloudflare-workers-and-pages bot commented Feb 7, 2025

Deploying atlantis with  Cloudflare Pages  Cloudflare Pages

Latest commit: c7c67db
Status: ✅  Deploy successful!
Preview URL: https://32f0ddd1.atlantis.pages.dev
Branch Preview URL: https://add-icon-docs.atlantis.pages.dev

View logs

@chris-at-jobber chris-at-jobber marked this pull request as ready for review February 7, 2025 20:03
@chris-at-jobber chris-at-jobber requested a review from a team as a code owner February 7, 2025 20:03
Copy link
Contributor

@scotttjob scotttjob left a comment

Choose a reason for hiding this comment

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

Rubber Stamped!

@chris-at-jobber chris-at-jobber merged commit 58c6d97 into master Feb 12, 2025
14 checks passed
@chris-at-jobber chris-at-jobber deleted the add-icon-docs branch February 12, 2025 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants