Skip to content

Improve docs consistency for Overlay, PageHead, Pagination, Popover, Portal, ProgressBar components - #1805

Merged
rezrah merged 17 commits into
mainfrom
docs/update-component-docs-pt2-rez
Feb 1, 2022
Merged

Improve docs consistency for Overlay, PageHead, Pagination, Popover, Portal, ProgressBar components#1805
rezrah merged 17 commits into
mainfrom
docs/update-component-docs-pt2-rez

Conversation

@rezrah

@rezrahrezrah commented Jan 18, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Part of #1701

Added / Updated docs for:

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

@rezrahrezrah added the skip changeset This change does not need a changelog label Jan 18, 2022
@changeset-bot

changeset-botBot commented Jan 18, 2022•
edited
Loading

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 201400f

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

@rezrahrezrah mentioned this pull request Jan 18, 2022
Closed
59 tasks
@github-actions

github-actionsBot commented Jan 18, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
dist/browser.esm.js61.64 KB (0%)
dist/browser.umd.js62 KB (0%)

@rezrahrezrah changed the title Improve docs consistency for Overlay componentsImprove docs consistency for Overlay, PageHead componentsJan 18, 2022
@rezrahrezrah changed the title Improve docs consistency for Overlay, PageHead componentsImprove docs consistency for Overlay, PageHead, Pagination componentsJan 18, 2022
@rezrahrezrah changed the title Improve docs consistency for Overlay, PageHead, Pagination componentsImprove docs consistency for Overlay, PageHead, Pagination, Popover componentsJan 18, 2022
@rezrahrezrah changed the title Improve docs consistency for Overlay, PageHead, Pagination, Popover componentsImprove docs consistency for Overlay, PageHead, Pagination, Popover, Portal componentsJan 18, 2022
@rezrah
rezrah marked this pull request as ready for review January 18, 2022 12:57
@rezrah
rezrah requested review from a team and siddharthkpJanuary 18, 2022 12:57
rezrah
rezrah commented Jan 18, 2022
View reviewed changes
Comment threaddocs/src/@primer/gatsby-theme-doctocat/nav.yml
# - title: Overlay
# url: /Overlay
- title: Overlay
url: /Overlay

@rezrahrezrahJan 18, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Unclear why this was hidden. Does anyone know?

@rezrahrezrah changed the title Improve docs consistency for Overlay, PageHead, Pagination, Popover, Portal componentsImprove docs consistency for Overlay, PageHead, Pagination, Popover, Portal, ProgressBar componentsJan 18, 2022
@rezrah
rezrah requested a review from colebemisJanuary 18, 2022 13:30
siddharthkp
siddharthkp reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Pagination.md
```

## Customizing link URLs
### Customizing link URLs

@siddharthkpsiddharthkpJan 18, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❤️

siddharthkp
siddharthkp approved these changes Jan 18, 2022
View reviewed changes

@siddharthkpsiddharthkp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Love to see it! ❤️

colebemis
colebemis reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Overlay.mdx Outdated
colebemis
colebemis reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Overlay.mdx Outdated
colebemis
colebemis reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Overlay.mdx Outdated
colebemis
colebemis reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Overlay.mdx Outdated
colebemis
colebemis reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Overlay.mdx Outdated
colebemis
colebemis reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Overlay.mdx Outdated
colebemis
colebemis reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Overlay.mdx Outdated
colebemis
colebemis reviewed Jan 18, 2022
View reviewed changes
Comment threaddocs/content/Overlay.mdx Outdated
colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/Popover.md Outdated
colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/Popover.md
Comment on lines +119 to +124
<PropsTableRow
name="as"
defaultValue="div"
type="string"
description="Sets the underlying HTML tag for the component"
/>

@colebemiscolebemisJan 19, 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.

Suggested change
<PropsTableRow
name="as"
defaultValue="div"
type="string"
description="Sets the underlying HTML tag for the component"
/>
<PropsTableAsRow
defaultElementType="div"
/>

@rezrahrezrahJan 27, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Same comment as before, this suggestion results in an empty row? @colebemis

colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/Pagehead.md
Comment on lines +24 to +29
<PropsTableRow
name="as"
defaultValue="div"
type="string"
description="Sets the underlying HTML tag for the component"
/>

@colebemiscolebemisJan 19, 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.

Suggested change
<PropsTableRow
name="as"
defaultValue="div"
type="string"
description="Sets the underlying HTML tag for the component"
/>
<PropsTableAsRow
defaultElementType="div"
/>

colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/Popover.md
Comment on lines +153 to +158
<PropsTableRow
name="as"
defaultValue="div"
type="string"
description="Sets the underlying HTML tag for the component"
/>

@colebemiscolebemisJan 19, 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.

Suggested change
<PropsTableRow
name="as"
defaultValue="div"
type="string"
description="Sets the underlying HTML tag for the component"
/>
<PropsTableAsRow
defaultElementType="div"
/>

@rezrahrezrahJan 21, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@colebemis This doesn't seem to work with html tags, getting an empty row. Any ideas? Screenshot 2022-01-21 at 14 16 36

colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/Popover.md Outdated
colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/ProgressBar.mdx Outdated
colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/ProgressBar.mdx Outdated
colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/ProgressBar.mdx Outdated
colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/ProgressBar.mdx Outdated
### ProgressBar

<PropsTable>
<PropsTableRow name="progress" type="number" description="Used to set the size of the green bar" />

@colebemiscolebemisJan 19, 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.

Is this required?

@rezrahrezrahJan 21, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

As in a required prop? No, it's optional. Defaults to 0 if it's not passed in.

colebemis
colebemis reviewed Jan 19, 2022
View reviewed changes
Comment threaddocs/content/ProgressBar.mdx Outdated
colebemis
colebemis approved these changes Feb 1, 2022
View reviewed changes

@colebemiscolebemis left a comment

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.

🚢

@rezrah
rezrah merged commit 63970fd into mainFeb 1, 2022
@rezrah
rezrah deleted the docs/update-component-docs-pt2-rez branch February 1, 2022 16:39
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@siddharthkpsiddharthkpsiddharthkp approved these changes
+1 more reviewer
@colebemiscolebemiscolebemis approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

reactskip changesetThis change does not need a changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rezrah@siddharthkp@colebemis