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

docs: better documentation for runtime #8190

Merged
merged 2 commits into from
Aug 23, 2023
Merged

docs: better documentation for runtime #8190

merged 2 commits into from
Aug 23, 2023

Conversation

ematipico
Copy link
Member

Changes

Closes #8060

Testing

N/A

Docs

/cc @withastro/maintainers-docs for feedback!

@ematipico ematipico requested a review from a team as a code owner August 22, 2023 14:18
@changeset-bot
Copy link

changeset-bot bot commented Aug 22, 2023 •
edited
Loading

🦋 Changeset detected

Latest commit: 457718a

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Aug 22, 2023
@ematipico ematipico changed the title docs: better documentation for getRuntime() docs: better documentation for runtime Aug 22, 2023
@ematipico
Copy link
Member Author

ematipico commented Aug 22, 2023 •
edited
Loading

cc @alexanderniebuhr should we add something about how to type the runtime?

@alexanderniebuhr
Copy link
Member

alexanderniebuhr commented Aug 23, 2023 •
edited
Loading

cc @alexanderniebuhr should we add something about how to type the runtime?

Sure thing, let me double check how typing would be best with the current types & will open another PR. Should not block this one.

Update: The types are not exported yet, I'll fix that and update the docs in another PR today.

alexanderniebuhr
alexanderniebuhr reviewed Aug 23, 2023
View reviewed changes
Copy link
Member

@alexanderniebuhr alexanderniebuhr left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This makes sense. 🎉

packages/integrations/cloudflare/README.md Show resolved Hide resolved
@ematipico
Copy link
Member Author

@alexanderniebuhr I committed a change where the types are now exported and improved the docs showing how users can type the runtime. Please have a look!

@ematipico ematipico force-pushed the fix/better-docs-for-cloudflare-plt-823 branch from b848783 to 457718a Compare August 23, 2023 11:15
@alexanderniebuhr
Copy link
Member

I like it!

sarah11918
sarah11918 approved these changes Aug 23, 2023
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.

Docs approves! 🥳

@ematipico ematipico merged commit 0be8d9b into main Aug 23, 2023
13 checks passed
@ematipico ematipico deleted the fix/better-docs-for-cloudflare-plt-823 branch August 23, 2023 15:00
This was referenced Aug 23, 2023
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sarah11918 sarah11918 sarah11918 approved these changes

@alexanderniebuhr alexanderniebuhr Awaiting requested review from alexanderniebuhr

Assignees
No one assigned
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Env vriables with Vite and Cloudflare, the new replace of getRuntime()
3 participants
@ematipico @alexanderniebuhr @sarah11918