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

Docs: update docs to represent v3 #733

Merged
merged 30 commits into from
Nov 10, 2023
Merged

Docs: update docs to represent v3 #733

merged 30 commits into from
Nov 10, 2023

Conversation

admah
Copy link
Contributor

@admah admah commented Oct 31, 2023

  • removes CLI refs from config tabs
  • removes content related to MF v1
  • removes content that isn't relevant to v3 (eg. mounts)
  • removes refs to deprecated/removed methods and functionality

Copy link

changeset-bot bot commented Oct 31, 2023

⚠️ No Changeset found

Latest commit: 639d8ca

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@admah admah marked this pull request as ready for review November 1, 2023 20:15
@admah admah changed the title [WIP] docs: update docs to represent v3 Docs: update docs to represent v3 Nov 1, 2023
@admah
Copy link
Contributor Author

admah commented Nov 1, 2023

@mrbbot a couple of things:

  • the Queues page is new and I don't know what content should go in there. Any help is greatly appreciated!
  • should I make all the examples show module syntax and SW syntax?
  • I removed refs to miniflare/storage-redis. Does that package no longer exist?

Copy link
Contributor

@mrbbot mrbbot left a comment

Choose a reason for hiding this comment

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

Thank you so much for doing this! 🥳 I've added a bunch of comments. In response to your questions:

the Queues page is new and I don't know what content should go in there. Any help is greatly appreciated!

I've added some comments inline.

should I make all the examples show module syntax and SW syntax?

I don't think we need to show both in all examples, but having a least one example of SW syntax somehwere would be good.

I removed refs to miniflare/storage-redis. Does that package no longer exist?

Yep, that package was Miniflare 2 only.

docs/index.md Outdated Show resolved Hide resolved
docs/src/content/core/fetch.md Outdated Show resolved Hide resolved
docs/src/content/core/fetch.md Outdated Show resolved Hide resolved
docs/src/content/core/fetch.md Outdated Show resolved Hide resolved
docs/src/content/get-started/index.md Outdated Show resolved Hide resolved
docs/src/content/get-started/index.md Outdated Show resolved Hide resolved
docs/src/content/get-started/index.md Show resolved Hide resolved
docs/src/content/index.md Outdated Show resolved Hide resolved
docs/src/content/storage/durable-objects.md Outdated Show resolved Hide resolved
@admah admah requested a review from mrbbot November 3, 2023 18:04
Copy link
Contributor

@mrbbot mrbbot 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 making those changes. It looks like there are still some unresolved comments in docs/src/content/get-started/index.md, and I've added one more minor thing, but other than that, looks good! 👍

docs/src/content/core/multiple-workers.md Outdated Show resolved Hide resolved
admah and others added 7 commits November 7, 2023 06:28
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
admah and others added 7 commits November 7, 2023 06:32
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
Co-authored-by: MrBBot <bcoll@cloudflare.com>
@admah
Copy link
Contributor Author

admah commented Nov 7, 2023

Thanks @mrbbot! I have resolved all open comments and committed that last change you made 👍

@mrbbot mrbbot linked an issue Nov 7, 2023 that may be closed by this pull request
@mrbbot mrbbot merged commit 7ef1635 into master Nov 10, 2023
3 of 6 checks passed
@mrbbot mrbbot deleted the admah/mf3docs branch November 10, 2023 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs for wrangler v3
2 participants