[D1] Creating proper API documentation #17923
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oxyjun
requested review from
elithrar,
rozenmd,
vy-ton,
joshthoward and
a team
as code owners
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
Deploying cloudflare-docs with
|
| Latest commit: |
236aad9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1e62b0b0.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://jun-d1-api-reshuffle.cloudflare-docs-7ou.pages.dev |
Oxyjun
requested review from
GregBrimble,
KianNH,
pedrosousa and
WalshyDev
as code owners
|
This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
3 tasks
|
double "API" is busy, not sure if we can change this |
vy-ton
approved these changes
Nov 14, 2024
I'll look into it - it might be a case where we can't change just this single one. |
marciocloudflare
approved these changes
Nov 15, 2024
Co-authored-by: marciocloudflare <[email protected]>
joshthoward
requested changes
Nov 15, 2024
joshthoward
approved these changes
Nov 19, 2024
harshil1712
pushed a commit
that referenced
this pull request
Dec 3, 2024
* Adding placeholder for new API section. * Initializing await stmt API chapter. * Reordering the sidebar. Adding intro to stmt.methods. * Setting up Worker Bindings API chapters. * Settling on naming convention, fleshing out .db chapter. * Setting up the database API section. * Fleshing out API chapters. * Updating D1 API docs. * Adding in more information to be complete. * Apply suggestions from code review Co-authored-by: Lambros Petrou <[email protected]> * Update src/content/docs/d1/worker-api/query.mdx * Updating the Return Object chapter. Testing more APIs. * Fleshing out the API docs in more detail. * Fixing broken link. * Changing reference to mention Worker Binding APIs. * Small rename. * Small rename. * Updating the chapters * Modifying the structure to align with discussion. * Renaming extensions header for better clarity. * Adding changelog entry for including multiple queries in a single prepared statement. * Updating wording in Get started to match new folders. * Fixing broken link * Implementing feedback. * Removing references to multi-statement prepare(). * Fixing broken links * Grammar fixes and deleting redundant comment block. * Apply suggestions from code review Co-authored-by: marciocloudflare <[email protected]> * Minor rename of the chapter * Cleaning up the structure by method hierarchy. * Adding a note for those who are following the tutorial with an existing Worker. * Actioning PR feedback. * Turning all method names into links to the relevant header. --------- Co-authored-by: Lambros Petrou <[email protected]> Co-authored-by: marciocloudflare <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
At the moment, this is purely additive. This causes duplication in the content, between "Query D1" chapter. We will have to tackle "Build with D1" on a separate PR.
Screenshots (optional)
Before (left) and after (right)
Expanded new sidebar folders:
Documentation checklist