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

Bold props interface words #1123

Merged
merged 2 commits into from
Aug 16, 2021
Merged

Bold props interface words #1123

merged 2 commits into from
Aug 16, 2021

Conversation

MarcusOtter
Copy link
Member

@MarcusOtter MarcusOtter commented Aug 16, 2021

Changes

  • What does this change?
    Bolds some words because a few people (me included) have missed these words 😄
    Makes a paragraph in the docs into a blockquote and makes "In the future" Bold and Italic

Closes #1070

Testing

Tested locally

Docs

Yes

@changeset-bot
Copy link

changeset-bot bot commented Aug 16, 2021

⚠️ No Changeset found

Latest commit: 0a78203

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

@vercel
Copy link

vercel bot commented Aug 16, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

astro-www – ./www

🔍 Inspect: https://vercel.com/pikapkg/astro-www/E1ZmZnf2uSy19jkBbctCFMCpTDux
✅ Preview: Canceled

[Deployment for 0a78203 canceled]

astro-docs – ./docs

🔍 Inspect: https://vercel.com/pikapkg/astro-docs/5D6Bre8myN3pvtbAh2Yxa4W6DSWi
✅ Preview: https://astro-docs-git-fork-marcusotter-docs-bold-word-pikapkg.vercel.app

@jasikpark
Copy link
Contributor

Thanks for making this PR! I think it might work best to italicize the entire sentence?

link to the changed sentence:
https://astro-docs-git-fork-marcusotter-docs-bold-word-pikapkg.vercel.app/core-concepts/astro-components#component-props

image

@jasikpark
Copy link
Contributor

Though maybe that's just a case where our bold weight needs to be more bold, actually 😅

@MarcusOtter
Copy link
Member Author

Yeah didn't do much of a change 😄 How about Bold italic to really get the point across?

@FredKSchott
Copy link
Member

Happy with anything here! FYI this will go out tomorrow when we release our main branch to npm install astro and cut v0.19.0.

@drwpow
Copy link
Member

drwpow commented Aug 16, 2021

I’m fine with any change here, but I think that we probably need more of a callout block that more explicitly highlights a future deprecation, or a coming soon feature like here.

@MarcusOtter
Copy link
Member Author

MarcusOtter commented Aug 16, 2021

I agree with @drwpow. It seems like blockquotes are currently used for this (a bit semantically incorrect but I understand that there aren't a lot of good alternatives in markdown). EDIT: Good future use case for #491?

Example:
image

Should I convert this paragraph to a blockquote?

@MarcusOtter
Copy link
Member Author

I did.

Before After
image image

@FredKSchott
Copy link
Member

LGTM! This will go out tomorrow when we release v0.19.0

@FredKSchott FredKSchott merged commit 47025a7 into withastro:main Aug 16, 2021
@MarcusOtter MarcusOtter deleted the docs-bold-word branch February 5, 2022 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📘 DOC: Make “Props interface typechecking” more obviously unimplemented in docs
4 participants