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 documentation on making dev overlay plugins #5183

Merged
merged 7 commits into from
Oct 26, 2023
Merged

Conversation

Princesseuh
Copy link
Member

@Princesseuh Princesseuh commented Oct 23, 2023

Description (required)

Docs for withastro/astro#8757.

Since the dev overlay API is very early still, the content is a bit light. But, this should provide a basic guide over the different hooks and features that should still be appreciated by the few people who will make dev overlay plugins already.

This is intentionally only in the references while the dev overlay is so early and very much lacking in features. In a very close future, I'll be sending a PR to add more references to it throughout the docs where relevant. (Right now, we don't mind too much people not using it, so no big marketing needed until it's very cool!)

@netlify
Copy link

netlify bot commented Oct 23, 2023

Deploy Preview for astro-docs-2 ready!

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

@Princesseuh Princesseuh added 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!) labels Oct 23, 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.

This is great @Princesseuh ! I almost feel like I could write a plugin... 😄

Left some suggestions, and I do think changing the main filename to dev-overlay-plugin-reference.mdx makes a lot of sense, since this really is geared towards writing plugins specifically.

See what you think about some of my suggestions below, and of course, change whatever is necessary!

src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/dev-overlay-reference.mdx Outdated Show resolved Hide resolved
@sarah11918
Copy link
Member

@Princesseuh This all looks amazing! I'm going to just re-visit that one note today, and was also wondering whether it's possible/makes sense to actually show the two included icons visually at the bottom of the page. Otherwise, this is pretty much ready for tomorrow!

@Princesseuh
Copy link
Member Author

@Princesseuh This all looks amazing! I'm going to just re-visit that one note today, and was also wondering whether it's possible/makes sense to actually show the two included icons visually at the bottom of the page. Otherwise, this is pretty much ready for tomorrow!

Hmm, that would definitely be nice, but I'm not sure how. Probably that the docs repo could take the icon's codes directly from the main repo and use them that way. Since it's still very possible for that file to move around and be changed fairly consequentially, I prefer doing it in a separate effort once the refactors are done!

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.

Ready for minor release! 🥳

@sarah11918 sarah11918 added the minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! label Oct 26, 2023
@sarah11918 sarah11918 merged commit f71d61e into main Oct 26, 2023
9 checks passed
@sarah11918 sarah11918 deleted the feat/dev-overlay branch October 26, 2023 16:18
NinuzIBZ added a commit to NinuzIBZ/docs that referenced this pull request Feb 1, 2024
The file `nav.ts` has been updated to align with the English language documentation based on this commits withastro#4876 , withastro#5183 , withastro#5213 , withastro#5271 , withastro#5187 , withastro#4667 , withastro#5541 , withastro#5605 , withastro#5499 , withastro#6470 , withastro#6620
@NinuzIBZ NinuzIBZ mentioned this pull request Feb 1, 2024
yanthomasdev added a commit that referenced this pull request Feb 5, 2024
The file `nav.ts` has been updated to align with the English language documentation based on this commits #4876 , #5183 , #5213 , #5271 , #5187 , #4667 , #5541 , #5605 , #5499 , #6470 , #6620

Co-authored-by: Yan Thomas <[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. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants