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

feat(next): routes resolved hook #10077

Merged
merged 8 commits into from
Nov 22, 2024
Merged

Conversation

florian-lefebvre
Copy link
Member

@florian-lefebvre florian-lefebvre commented Nov 20, 2024

Description (required)

withastro/astro#12329

Related issues & labels (optional)

  • Closes #
  • Suggested label:

Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit c3d1215
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/6740ae4cf4bb170008900f78
😎 Deploy Preview https://deploy-preview-10077--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
Contributor

astrobot-houston commented Nov 20, 2024

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

File Note
en/guides/upgrade-to/v5.mdx Source changed, localizations will be marked as outdated.
en/reference/integrations-reference.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.

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.

Looks great @florian-lefebvre ! Just need to phrase this more like a "What should I do?" so I made a basic model, but you should update as necessary!

src/content/docs/en/guides/upgrade-to/v5.mdx Outdated Show resolved Hide resolved
@sarah11918
Copy link
Member

Oh, and are we documenting this on the Integrations API page too? Is that coming later?

@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. 5.0.0-beta labels Nov 20, 2024
@florian-lefebvre florian-lefebvre marked this pull request as ready for review November 20, 2024 16:18
@florian-lefebvre
Copy link
Member Author

There you go 😄

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.

Some minor edits and suggestions below! We'll get this wrapped up well in time for a release tomorrow, no worries!

src/content/docs/en/guides/upgrade-to/v5.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/integrations-reference.mdx Outdated Show resolved Hide resolved
```ts
interface IntegrationResolvedRoute {
/**
* The current **pattern** of the route. For example:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* The current **pattern** of the route. For example:
* The current **pattern** of the route, the path relative to the `src/pages/` directory and without a file extension. For example:

This appears to be the pattern, right? Would you change this description?

Copy link
Member Author

Choose a reason for hiding this comment

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

All those jsdoc come directly from core, and are also in astro:build:done. So do you prefer not to update the jsdoc on that page at all, or update them in core and then reflect the changes here?

Copy link
Member

Choose a reason for hiding this comment

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

Ah, OK. How important is it that these are kept identical to core? This is public facing docs, and one could argue should be written like docs.

(I was even thinking, this is a LOT of documenting going on inside a code sample. Why aren't we writing normal docs here?)

In that case, I'm OK to merge exactly what's already matching, but then think about at some point in the future this page becomes an actual docs page, not just copy paste of whatever you've written in code that I have no control over the quality of. 😅

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah I think that's a good idea 👍

src/content/docs/en/guides/upgrade-to/v5.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/integrations-reference.mdx Outdated Show resolved Hide resolved
@sarah11918 sarah11918 added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label Nov 20, 2024
Co-authored-by: Sarah Rainsberger <[email protected]>
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.

@florian-lefebvre

See my comment about being OK to copy these as-is since this is apparently just a reproduction of what's in code.

BUT, these don't feel like the best docs to me. (Why is docs just a copy of code comments and not "documentation"?) We can leave that for some potential future exploration, whether this page needs itself an overhaul! And we don't have to block merging for the feature!

@florian-lefebvre
Copy link
Member Author

I think we can still take care of #10077 (comment) in this one tho!

@sarah11918
Copy link
Member

Sure! Can you propose an example that would go there?

@florian-lefebvre
Copy link
Member Author

@sarah11918 i tried to add a little example, let me know what you think!

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.

Just left the tiniest suggestion, but good to go whenever you're happy with it! (And, we can think about whether we want to improve this page overall in future!) 🚀

@florian-lefebvre florian-lefebvre merged commit a039e65 into 5.0.0-beta Nov 22, 2024
6 checks passed
@florian-lefebvre florian-lefebvre deleted the feat/routes-resolved branch November 22, 2024 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0.0-beta add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants