Skip to content

Docs: Remove drafts silliness from examples - #1785

Merged
siddharthkp merged 18 commits into
mainfrom
siddharth/docs-dynamic-drafts-scope
Jan 31, 2022
Merged

Docs: Remove drafts silliness from examples#1785
siddharthkp merged 18 commits into
mainfrom
siddharth/docs-dynamic-drafts-scope

Conversation

@siddharthkp

@siddharthkpsiddharthkp commented Jan 11, 2022•
edited
Loading

Copy link
Copy Markdown
Member

Checklist:

Problem:

Because drafts is scoped, we have some implementation detail silliness in the examples:

before:

docs implementation silliness

Solution: By making live-code-scope accept a function (doctocat/332), we can make scope dynamic based on metastring:

- ```javascript live+ ```jsx live drafts

after, so clean, yay:

no silliness

@siddharthkp
siddharthkp requested review from a team and colebemisJanuary 11, 2022 13:07
@changeset-bot

changeset-botBot commented Jan 11, 2022•
edited
Loading

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 0c93480

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@siddharthkp
siddharthkp temporarily deployed to visual-testing January 11, 2022 13:07 Inactive
@siddharthkpsiddharthkp added docs Documentation react skip changeset This change does not need a changelog labels Jan 11, 2022
@github-actions

github-actionsBot commented Jan 11, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
dist/browser.esm.js61.34 KB (0%)
dist/browser.umd.js61.71 KB (0%)

@siddharthkpsiddharthkp mentioned this pull request Jan 11, 2022
Merged
@siddharthkpsiddharthkp self-assigned this Jan 11, 2022
@siddharthkpsiddharthkp mentioned this pull request Jan 11, 2022
Closed
@siddharthkpsiddharthkp changed the title Docs: Make live-code scope dynamic for draftsDocs: Make drafts examples cleanJan 11, 2022
@siddharthkpsiddharthkp changed the title Docs: Make drafts examples cleanDocs: Remove drafts silliness from examplesJan 11, 2022
@mperrottimperrotti mentioned this pull request Jan 12, 2022
Closed
8 tasks
mperrotti
mperrotti reviewed Jan 12, 2022
View reviewed changes
Comment threaddocs/package.json Outdated
},
"dependencies": {
"@primer/gatsby-theme-doctocat": "^3.1.0",
"@primer/gatsby-theme-doctocat": "0.0.0-2022011123325",

@mperrottimperrottiJan 12, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approval assumes this will be updated after your doctocat PR merges

@mperrottimperrotti mentioned this pull request Jan 14, 2022
Merged
6 tasks
siddharthkp
siddharthkp commented Jan 14, 2022
View reviewed changes
Comment thread.eslintrc.json
"@typescript-eslint/no-unused-vars": 0,
"primer-react/no-deprecated-colors": ["error", {"skipImportCheck": true}]
"primer-react/no-deprecated-colors": ["error", {"skipImportCheck": true}],
"no-redeclare": 0

@siddharthkpsiddharthkpJan 14, 2022•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Added this for code blocks so that we can write this block ⬇️ without adding a // eslint-ignore inside the code block

// ESMimport{ActionList}from'@primer/react/lib-esm/drafts'// or commonjs:import{ActionList}from'@primer/react/lib/drafts'

@siddharthkp

siddharthkp commented Jan 14, 2022

Copy link
Copy Markdown
MemberAuthor

Update: Brought in changes from #1778 to this PR

@siddharthkp

siddharthkp commented Jan 19, 2022

Copy link
Copy Markdown
MemberAuthor

@colebemis I think we're ready here!

@siddharthkpsiddharthkp mentioned this pull request Jan 19, 2022
Merged
@siddharthkpsiddharthkp added this to the FY22 - Q3 milestone Jan 20, 2022
pksjce
pksjce reviewed Jan 21, 2022
View reviewed changes
Comment threaddocs/content/drafts/ActionList2.mdx
@siddharthkp
siddharthkp merged commit 5e4b60c into mainJan 31, 2022
@siddharthkp
siddharthkp deleted the siddharth/docs-dynamic-drafts-scope branch January 31, 2022 13:13
@siddharthkp

siddharthkp commented Jan 31, 2022

Copy link
Copy Markdown
MemberAuthor

Talked to @pksjce about #1771. There will be be some more improvements after that PR is merged 🎉 Until then, this is a step in the right direction, so merged :)

@siddharthkpsiddharthkp mentioned this pull request Feb 8, 2022
Merged
2 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@colebemiscolebemisAwaiting requested review from colebemis
@rezrahrezrahAwaiting requested review from rezrah
2 more reviewers
@pksjcepksjcepksjce left review comments
@mperrottimperrottimperrotti approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@siddharthkpsiddharthkp

Labels

docsDocumentationreactskip changesetThis change does not need a changelog

Projects

None yet

Milestone

FY22 - Q3

Development

Successfully merging this pull request may close these issues.

Multiple Alpha components can't be used despite being available in the documentation.

3 participants

@siddharthkp@pksjce@mperrotti