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

Redistribute Built-in components and remove page #9888

Merged
merged 47 commits into from
Nov 5, 2024
Merged

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Oct 30, 2024

Description (required)

This PR removes the Built-in Components reference page entirely in favour of redistributing the components to appropriate pages in docs.

(These components were not very similar to each other, did not all require imports, and in some cases were duplicate content existing in guides already.)

In the process:

  • Creates a new Syntax Highlighting guide for both Markdown code block advice with the Code and Prism components which otherwise didn't have a super obvious place to go. This alleviates some of the content in the Markdown guide and describes all code syntax highlighting options together
  • Moves markdown.shikiConfig content to configuration reference rather than having that entry link to the Markdown guide (in-branch overwrite right now, until we know what we want at the source)
  • Makes the syntax highlighting content more "guide" like
  • removes some "asides" in favour of proper documentation of "how things work"

Note: If we don't like the experiment of syntax highlighting as its own guide, this content can go back to the Markdown guide page. However, we would need to decide on a better place for the two Code and Prism components

UPDATE: The experimental changes above were well received on Talking and Doc'ing, so going with this overall structure for now!

  • Structure for new syntax higlighting page
  • file name and page title for new syntax highlighting page
  • deal with link fall out
  • remove component reference page from all i18n/nav pages that had it
  • LUNARIA TRACKING STATEMENT

Follow up:

  • Make a PR for configuration reference (astro main branch) with the new Shiki config reference (PR here)
  • If someone wants to make it actually reference-y at some point/in the process, that's fine too!

sarah11918 and others added 29 commits October 25, 2024 15:20
Co-authored-by: Armand Philippot <[email protected]>
Co-authored-by: Armand Philippot <[email protected]>
@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Oct 30, 2024
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Nov 6, 2024
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Nov 6, 2024
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Nov 6, 2024
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Nov 6, 2024
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Nov 6, 2024
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Nov 6, 2024
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Nov 6, 2024
yanthomasdev added a commit that referenced this pull request Nov 6, 2024
* i18n(fr): Update `guides/troubleshooting.mdx` from #9888

Signed-off-by: Thomas Bonnet <[email protected]>

* Blank line

Co-authored-by: Armand Philippot <[email protected]>

---------

Signed-off-by: Thomas Bonnet <[email protected]>
Co-authored-by: Armand Philippot <[email protected]>
Co-authored-by: Yan <[email protected]>
yanthomasdev added a commit that referenced this pull request Nov 6, 2024
yanthomasdev added a commit that referenced this pull request Nov 6, 2024
…n-reference.mdx` (#9934)

* i18n(fr): add `guides/syntax-highlighting.mdx`

See #9888

* i18n(fr): update `configuration-reference.mdx`

See #9888

* i18n(fr): update a link in `integrations-guide/markdoc.mdx`

---------

Co-authored-by: Yan <[email protected]>
Co-authored-by: thomasbnt <[email protected]>
yanthomasdev added a commit that referenced this pull request Nov 6, 2024
* i18n(fr): Update `guides/markdown-content.mdx` from #9888

Signed-off-by: Thomas Bonnet <[email protected]>

* blank line

Co-authored-by: Armand Philippot <[email protected]>

* blank lines

Co-authored-by: Armand Philippot <[email protected]>

* space before colon and last comment line was not translated

Co-authored-by: Armand Philippot <[email protected]>

* i18n(fr): Update `guides/v1.mdx` from #9888

Signed-off-by: Thomas Bonnet <[email protected]>

---------

Signed-off-by: Thomas Bonnet <[email protected]>
Co-authored-by: Armand Philippot <[email protected]>
Co-authored-by: Yan <[email protected]>
yanthomasdev added a commit that referenced this pull request Nov 6, 2024
See #9900 and #9888

Co-authored-by: Yan <[email protected]>
Co-authored-by: thomasbnt <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! information architecture reorganizes content on the site
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants