docs icon indicating copy to clipboard operation
docs copied to clipboard

(en) `github.mdx`: The description of the text is discrepancy.

Open debiru opened this issue 8 months ago • 5 comments

📚 Subject area/topic

guides/deploy

📋 Page(s) affected (or suggested, for new content)

https://docs.astro.build/en/guides/deploy/github/

📋 Description of content that is out-of-date or incorrect

The leading slash in the value of the base parameter is being removed by #7481.

However, the text explains that the base parameter value must be prefixed with slash.

The value for base should be your repository’s name starting with a forward slash, for example /my-blog. This is so that Astro understands your website’s root is /my-repo, rather than the default /.

Incidentally, when I tried deploying with GitHub Pages, I was able to deploy successfully with or without the slash. What exactly was the problem with #7481? And please think of a way to resolve this discrepancy.

NOTE: Or rather, there are several inaccurate statements in addition to the points pointed out above. You may want to carefully verify that the entire text is correct.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

debiru avatar Feb 02 '25 14:02 debiru