Added caution element to the anchor section.

[nicogutz]

This will help users understand that Astro does not manage anchor elements

Description (required)

When building with a base config other than / , none of the hrefs on anchor elements are changed. This is never explicitly mentioned in the documentation. I added a caution element to inform users that they have to change it manually and gave them two main options to do so.

Related issues & labels (optional)

• Closes Add a tip telling the user that anchor elements are not affected by base config #8465, closes Base does not change href value in anchors. astro#11159
• Suggested label: add+new+content

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs	❌ Failed (Inspect)		Jun 8, 2024 1:22pm

[astrobot-houston]

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

1. Our GitHub bots will run to check your changes.
   If they spot any broken links you will see some error messages on this PR.
   Don’t hesitate to ask any questions if you’re not sure what these mean!

2. In a few minutes, you’ll be able to see a preview of your changes on Vercel 🥳

3. One or more of our maintainers will take a look and may ask you to make changes.
   We try to be responsive, but don’t worry if this takes a few days.

[astrobot-houston]

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale	File	Note
en	guides/routing.mdx	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.

[at-the-vr]

Great PR @nicogutz 🔥🔥. LGTM 👍

[sarah11918]

Thank you for this helpful addition, @nicogutz ! The information is absolutely great to have here! I've just changed the formatting to be more consistent with Astro Docs style!

I think the example below serves the purpose of demonstrating that base needs to be taken into account when creating URLs. Given that this is a very introductory section, and there are a variety of ways that handling the base can be accomplished, we prefer to keep the documentation simple and illustrative here.

Thank you again for this very helpful contribution, and welcome to Team Docs! 🥳

[sarah11918]

Suggested change

	<p>Read more <a href="/about/">about</a> Astro!</p>
	```
	:::caution
	Changing the [base](/en/reference/configuration-reference/#base) configuration option does not change the `href` of `<a>` elements. This has to be done manually using `Astro.url` or `import.meta.env.BASE_URL` on each element.
	:::
	<p>Read more <a href="/about/">about</a> Astro!</p>
	<!-- With `base: "/docs"` configured -->
	<p>Learn more in our <a href="/docs/reference/">reference</a> section!</p>
	```

We only use caution very rarely, for things like security issues. In general, we prefer to document "how something works" properly in the first place, not add notes on like we forgot to say something. 😅

When multiple options are possible, we usually extend the code block to show more examples. I think this is helpful!

[nicogutz]

We only use caution very rarely, for things like security issues. In general, we prefer to document "how something works" properly in the first place, not add notes on like we forgot to say something. 😅

I will keep that in mind for next time 😃 , nevertheless, the example shows the opposite of what happens, see withastro/astro#11159. The base never changes the href.

This is why I thought it was important to explicitly indicate that the anchors are not changed with the base config parameter. A user coming from other frameworks might assume that since the assets are changed by the config, then the anchors must be automatically changed as well.