Skip to content

[i18nIgnore] [reference] new components page#9465

Merged
sarah11918 merged 16 commits intomainfrom
components-reference
Oct 5, 2024
Merged

[i18nIgnore] [reference] new components page#9465
sarah11918 merged 16 commits intomainfrom
components-reference

Conversation

@sarah11918
Copy link
Copy Markdown
Member

Description (required)

This splits out the "Built-in components" section at the bottom of API reference into its own page. This makes them easier to find, and helps with the API reference page getting too long for Algolia to properly index

@netlify
Copy link
Copy Markdown

netlify bot commented Sep 22, 2024

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 50c6179
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/6701352de7ef7c0008222c7c
😎 Deploy Preview https://deploy-preview-9465--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented Sep 22, 2024

Lunaria Status Overview

🌑 This pull request will not trigger status changes.

Learn more

Lunaria automatically ignores changes on specific PRs by adding a ignored keyword in its title. Found: i18nIgnore.

You can change this by either removing the keyword above from the PR's title, or modifying the ignoreKeywords property in your Lunaria configuration file.

Tracked Files

Note

The notes below indicate what would happen if the pull request is merged when triggering status changes. Since a ignored keyword was found in the PR's title, the status changes indicated below won't be applied.

Locale File Note
de guides/markdown-content.mdx Localization changed, will be marked as complete.
de guides/troubleshooting.mdx Localization changed, will be marked as complete.
en basics/astro-components.mdx Source changed, localizations will be marked as outdated.
en guides/markdown-content.mdx Source changed, localizations will be marked as outdated.
en guides/troubleshooting.mdx Source changed, localizations will be marked as outdated.
en guides/upgrade-to/v1.mdx Source changed, localizations will be marked as outdated.
en reference/api-reference.mdx Source changed, localizations will be marked as outdated.
en reference/components-reference.mdx Source added, will be tracked.
es basics/astro-components.mdx Localization changed, will be marked as complete.
es guides/markdown-content.mdx Localization changed, will be marked as complete.
es guides/troubleshooting.mdx Localization changed, will be marked as complete.
fr guides/markdown-content.mdx Localization changed, will be marked as complete.
fr guides/troubleshooting.mdx Localization changed, will be marked as complete.
fr guides/upgrade-to/v1.mdx Localization changed, will be marked as complete.
hi basics/astro-components.mdx Localization changed, will be marked as complete.
it basics/astro-components.mdx Localization changed, will be marked as complete.
ja basics/astro-components.mdx Localization changed, will be marked as complete.
ja guides/markdown-content.mdx Localization changed, will be marked as complete.
ja guides/troubleshooting.mdx Localization changed, will be marked as complete.
ko basics/astro-components.mdx Localization changed, will be marked as complete.
ko guides/markdown-content.mdx Localization changed, will be marked as complete.
ko guides/troubleshooting.mdx Localization changed, will be marked as complete.
pl basics/astro-components.mdx Localization changed, will be marked as complete.
pt-br basics/astro-components.mdx Localization changed, will be marked as complete.
pt-br guides/markdown-content.mdx Localization changed, will be marked as complete.
pt-br guides/troubleshooting.mdx Localization changed, will be marked as complete.
ru basics/astro-components.mdx Localization changed, will be marked as complete.
ru guides/markdown-content.mdx Localization changed, will be marked as complete.
zh-cn basics/astro-components.mdx Localization changed, will be marked as complete.
zh-cn guides/markdown-content.mdx Localization changed, will be marked as complete.
zh-cn guides/troubleshooting.mdx Localization changed, will be marked as complete.
zh-tw basics/astro-components.mdx Localization changed, will be marked as complete.
en nav.ts Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Sep 22, 2024
@sarah11918 sarah11918 changed the title [reference] new components page [i18nIgnore] [reference] new components page Sep 22, 2024
@sarah11918 sarah11918 marked this pull request as ready for review September 24, 2024 17:47
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot left a comment

Choose a reason for hiding this comment

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

Regarding the split, I have nothing to say... besides reducing the size of api-reference.mdx, I think it adds visibility for those only interested in components. So, LGTM!
But since I'm here... some nitpicking regarding code snippets. 😄

Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Copy link
Copy Markdown
Contributor

@VoxelMC VoxelMC left a comment

Choose a reason for hiding this comment

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

Awesome, LGTM. Thank you!

This will make these more intuitive to find for sure!

A few tiny comments are all I have for ya.

sarah11918 and others added 3 commits October 5, 2024 09:08
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: voxel!() <voxelmc@hotmail.com>
Co-authored-by: voxel!() <voxelmc@hotmail.com>
@sarah11918
Copy link
Copy Markdown
Member Author

!coauthor

@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 5, 2024

Co-authored-by: Houston (Bot) <108291165+astrobot-houston@users.noreply.github.com>
Co-authored-by: voxel!() <voxelmc@hotmail.com>
Co-authored-by: Armand Philippot <59021693+ArmandPhilippot@users.noreply.github.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>

Comment on lines +4 to +6
tableOfContents:
minHeadingLevel: 2
maxHeadingLevel: 2
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Until we go through and structure this page and we decide what it will look like, temporary fix so that only the components show up in the TOC.

(The alternative would be to convert ### to <h3>, which would also be fine! This way preserves our normal Markdown authoring.)

import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro';
import ReadMore from '~/components/ReadMore.astro';

Astro includes several built-in components for you to use in your projects. All built-in components are available in `.astro` files via `import {} from 'astro:components'`.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The heading that was here was redundant (pulled directly from the other page where it was simply a page section.)

This means we don't need it here, and all the components can be ##.

@sarah11918 sarah11918 merged commit b13d251 into main Oct 5, 2024
@sarah11918 sarah11918 deleted the components-reference branch October 5, 2024 12:49
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Oct 7, 2024
Nin3lee added a commit to Nin3lee/docs that referenced this pull request Oct 8, 2024
yanthomasdev added a commit that referenced this pull request Oct 8, 2024
* i18n(fr): add `components-reference.mdx`

See #9465

* reword: ceci > il

Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com>

---------

Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
yanthomasdev added a commit that referenced this pull request Oct 8, 2024
…dx` (#9435)

* i18n(zh-cn): Update `api-reference.mdx`

* phrase polish

* Update `api-reference.mdx` from #9465

* add `components-reference.mdx`

* Update headings

* Update headings

---------

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
trueberryless added a commit to trueberryless/withastro-docs that referenced this pull request Oct 20, 2024
yanthomasdev added a commit that referenced this pull request Nov 4, 2024
* update translation #9465

* update translation #8302 #8393

* update translation #6864

* update translation #5712

* fix heading levels (couldnt find pr history changes on en version)

---------

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants