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

Add title and adjust highlight in configured redirects code samples #3992

Merged
merged 3 commits into from Aug 1, 2023
Merged

Add title and adjust highlight in configured redirects code samples #3992

merged 3 commits into from Aug 1, 2023

Conversation

AishaBlake
Copy link
Contributor

What kind of changes does this PR include?

  • Minor content fixes (broken links, typos, etc.)

Description

  • No issue but addresses request from @sarah11918
  • Adds a title missing from the third code snippet in the Configured Redirects section of the Routing page. In addition, I adjusted the highlights in the first and third code snippets so that they mark the code being described in the text. In the current version, the first code snippet highlights the final line and two lines that don't exist (7-9).

Before:
current code samples in configured redirects section linked above

After:
same code sample, now both showing config.astro.mjs as the title and with only the redirect configuration code highlighted

@netlify
Copy link

netlify bot commented Jul 31, 2023

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2ab924d
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/64c932ae10dd6900085ecbb4
😎 Deploy Preview https://deploy-preview-3992--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.

@AishaBlake AishaBlake mentioned this pull request Jul 31, 2023
23 tasks
@sarah11918 sarah11918 added the improve documentation Enhance existing documentation (e.g. add an example, improve description) label Aug 1, 2023
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thanks so much for jumping on this @AishaBlake! I love me some consistent titles, and oh no, how did we never catch the previous wonky highlighting? 😅

Just quick suggestion below to see what you think, and so thrilled to be welcoming you to Team Docs! 🥳

src/content/docs/en/core-concepts/routing.mdx Outdated Show resolved Hide resolved
@@ -251,7 +251,7 @@ These redirects follow the same rules as file-based routes. Dynamic routes are a

Using SSR or a static adapter, you can also provide an object as the value, allowing you to specify the `status` code in addition to the new `destination`:

```js
```js title="astro.config.mjs" {5-8}
Copy link
Member

Choose a reason for hiding this comment

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

Totally agree with not also highlighting redirects here, since we're focusing on the object that you can provide! 🙌

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@AishaBlake
Copy link
Contributor Author

Your suggestion makes sense to me, @sarah11918! Thanks for the warm welcome. Contributing here reminds me of the parts that I actually enjoyed of a certain previous job. 😅

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Looking great to me! I'm approving to get this in our merge queue, since it's a constant "update branch" battle around here while Yan is merging translation PRs. But this will go live just as soon as can!

Thanks again for taking the time to contribute while I know you're so busy with other, non-tech endeavours. Does this mean... maybe we see an Astro Opal Grove Games website in the near future??? 👀 😄

@sarah11918 sarah11918 merged commit 8fccdc9 into withastro:main Aug 1, 2023
12 checks passed
@AishaBlake
Copy link
Contributor Author

Actually, yes! I migrated my personal site as a test and now I'm working on moving Opal Grove's over. Starting with the one Astro Shopify theme but I've got a bunch of things I want to add 🤩

I'll share more on Twitter but excited about this first little PR!

@AishaBlake AishaBlake deleted the patch-1 branch August 2, 2023 00:34
HawtinZeng pushed a commit to HawtinZeng/AstroDocs that referenced this pull request Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants