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: use CodeExampleTabs from badge to button-group #185

Merged
merged 6 commits into from
Mar 7, 2024

Conversation

iropolo
Copy link
Contributor

@iropolo iropolo commented Mar 4, 2024

use CodeExampleTabs from badge to button-group

Jira ticket: https://dialpad.atlassian.net/browse/DLT-691

Implemented our new CodeExampleTabs component into:

  • badge
  • banner
  • breadcrumbs
  • button
  • button-group

Images:

image image image image

@iropolo iropolo marked this pull request as ready for review March 4, 2024 20:58
@francisrupert
Copy link
Contributor

francisrupert commented Mar 4, 2024

Man, I love everything about this. A few screenshots with questions/feedback within.

image image image image

Copy link
Contributor

@braddialpad braddialpad left a comment

Choose a reason for hiding this comment

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

Sweet! Had a quick look will review more thoroughly tomorrow.

@braddialpad
Copy link
Contributor

re the 2 space indentation thing.. I was having trouble getting this working.. maybe this? https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs

@iropolo
Copy link
Contributor Author

iropolo commented Mar 5, 2024

Man, I love everything about this. A few screenshots with questions/feedback within.

image

Uh.. ye... I will remove it from CodeWellHeader.vue component, Im wondering the case that it was useful.

image

Done 👍🏼

image

It has 2 Tabs (4 spaces), the same as the avatar component (the first one we move it to CodeExampleTabs).
I can move it to 2 spaces. Lemme move all of them to 2 spaces.

image

Ye I thought that, but it is repeating a lot of code and it can be quite large.
I can add them and lets see..

@iropolo
Copy link
Contributor Author

iropolo commented Mar 5, 2024

re the 2 space indentation thing.. I was having trouble getting this working.. maybe this? https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs

sure, lemme see if I can add it quickly if it not, I will create a jira ticket to tackle it later.

@iropolo iropolo added the visual-test-ready Add this tag when the PR is ready for visual test, to trigger GHA visual tests label Mar 5, 2024
@dialpad dialpad deleted a comment from github-actions bot Mar 5, 2024
@iropolo
Copy link
Contributor Author

iropolo commented Mar 6, 2024

re the 2 space indentation thing.. I was having trouble getting this working.. maybe this? https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs

sure, lemme see if I can add it quickly if it not, I will create a jira ticket to tackle it later.

Okay I added it, but seems like it does not interact inside our codeBlocks

Screen.Recording.2024-03-06.at.11.52.13.mov

To test it, im using https://www.npmjs.com/package/eslint-plugin-markdownlint
run pnpm add --save-dev eslint-plugin-markdownlint --filter dialtone-documentation
go to apps/dialtone-documentation/.eslintrc.cjs
add (my confg)

  overrides: [{
    files: ["*.md"],
    parser: "eslint-plugin-markdownlint/parser",
    extends: ["plugin:markdownlint/recommended"],
    rules: {
      "markdownlint/md033": 'off',
      "markdownlint/md013": 'off'
    }
  }],

@dialpad dialpad deleted a comment from github-actions bot Mar 6, 2024
@dialpad dialpad deleted a comment from github-actions bot Mar 6, 2024
@dialpad dialpad deleted a comment from github-actions bot Mar 6, 2024
Copy link

github-actions bot commented Mar 6, 2024

✔️ Deploy previews ready!
😎 Dialtone preview: https://dialtone.dialpad.com/deploy-previews/pr-185/

@iropolo
Copy link
Contributor Author

iropolo commented Mar 6, 2024

Okay, should be ok to review it.
@francisrupert @braddialpad

@iropolo iropolo requested a review from braddialpad March 6, 2024 15:56
@braddialpad
Copy link
Contributor

braddialpad commented Mar 7, 2024

Okay I added it, but seems like it does not interact inside our codeBlocks

Hmm yeah thought that might happen, maybe we can do a separate story for this one.

@iropolo iropolo merged commit 808015b into staging Mar 7, 2024
7 checks passed
@iropolo iropolo deleted the DLT-691-vue-examples branch March 7, 2024 19:09
@iropolo
Copy link
Contributor Author

iropolo commented Mar 7, 2024

Okay I added it, but seems like it does not interact inside our codeBlocks

Hmm yeah thought that might happen, maybe we can do a separate story for this one.

Jira ticket: https://dialpad.atlassian.net/browse/DLT-1600

braddialpad pushed a commit that referenced this pull request Mar 7, 2024
# [9.18.0](dialtone/v9.17.0...dialtone/v9.18.0) (2024-03-07)

### Bug Fixes

* message input issues ([#190](#190)) ([caa07b6](caa07b6))
* remove markRaw ([#191](#191)) ([74884e2](74884e2))

### Documentation

* use CodeExampleTabs from badge to button-group ([#185](#185)) ([808015b](808015b))

### Features

* **Editor:** add quick replies icon to editor ([#193](#193)) ([7a6829f](7a6829f))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
visual-test-ready Add this tag when the PR is ready for visual test, to trigger GHA visual tests
Projects
None yet
3 participants