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.

Sign up for GitHub

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

Jump to bottom

Update docs for advanced APIs #9308

Merged
merged 2 commits into from
Sep 5, 2024
Merged

Update docs for advanced APIs #9308

merged 2 commits into from
Sep 5, 2024

Conversation

Fryuni
Copy link
Member

@Fryuni Fryuni commented Sep 5, 2024

Description

  • Updates the docs for the programmatic APIs for Astro commands dev, build, preview and sync.
  • Document DevServer, the return type of dev
  • Document PreviewServer, the return type of preview

Related issues & labels

@netlify Netlify
Copy link

netlify bot commented Sep 5, 2024 •
edited
Loading

✅ Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit b1d5028
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/66d9b074099d5b0008cf227a
😎 Deploy Preview https://deploy-preview-9308--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 Sep 5, 2024 •
edited
Loading

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 reference/cli-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.

delucis
delucis reviewed Sep 5, 2024
View reviewed changes
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Thanks for your grievances! They are lovely.

👋 Hello from Talking and Doc’ing

src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
@Fryuni @delucis
A lot of talking and a lot of doc'ing
b1d5028 
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
sarah11918
sarah11918 approved these changes Sep 5, 2024
View reviewed changes
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.

Watched the live review on Talking and Doc'ing! Great work everyone!

@delucis delucis merged commit 01b2a3d into main Sep 5, 2024
10 checks passed
@delucis delucis deleted the fryuni/update-advanced-apis branch September 5, 2024 13:32
@bluwy
Copy link
Member

bluwy commented Sep 5, 2024

I think it's best if we don't document the DevServer and PreviewServer type for now. I intentionally left it out before as it's not an API shape I'm happy with and it'll likely change before we stabilize it. The rest of the changes looks great though.

ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Sep 5, 2024
@ArmandPhilippot
i18n(fr): update cli-reference.mdx
56bfba8 
See withastro#9308
@ArmandPhilippot ArmandPhilippot mentioned this pull request Sep 5, 2024
Merged
yanthomasdev added a commit that referenced this pull request Sep 5, 2024
@ArmandPhilippot @yanthomasdev
i18n(fr): update cli-reference.mdx (#9310)
3c9fa1c 
* i18n(fr): update `cli-reference.mdx`

See #9308

* i18n(fr): add missing space before colon for Type and Default

---------

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
@jsparkdev jsparkdev mentioned this pull request Sep 6, 2024
Merged
@Nin3lee Nin3lee mentioned this pull request Sep 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@delucis delucis delucis left review comments

@HiDeoo HiDeoo HiDeoo approved these changes

@sarah11918 sarah11918 sarah11918 approved these changes

@TheOtterlord TheOtterlord TheOtterlord approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@Fryuni @astrobot-houston @bluwy @delucis @HiDeoo @sarah11918 @TheOtterlord