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 QueryApi context object information #1500

Merged
merged 4 commits into from
Sep 29, 2023
Merged

Conversation

bucanero
Copy link
Collaborator

No description provided.

@render
Copy link

render bot commented Sep 21, 2023

@bucanero bucanero marked this pull request as draft September 21, 2023 18:52
@bucanero bucanero requested a review from darunrs September 21, 2023 18:52
@bucanero bucanero marked this pull request as ready for review September 26, 2023 01:51
Copy link

@darunrs darunrs left a comment

Choose a reason for hiding this comment

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

Overall really nicely done! I love the addition of bubble text for things like tips. It feels very engaging. Some specific places I think could be reworded. In general, I wrote the stuff up with our team as the audience in mind. This document has a different audience in mind so some sentences read a bit clunky. Maybe a quick pass through to detect any weird language that talk about the developer/customer like they're not the one reading the doc would go a long way, I think.

docs/bos/queryapi/context.md Outdated Show resolved Hide resolved
docs/bos/queryapi/context.md Outdated Show resolved Hide resolved
docs/bos/queryapi/context.md Outdated Show resolved Hide resolved
docs/bos/queryapi/context.md Outdated Show resolved Hide resolved
docs/bos/queryapi/context.md Outdated Show resolved Hide resolved
docs/bos/queryapi/context.md Outdated Show resolved Hide resolved
docs/bos/queryapi/context.md Outdated Show resolved Hide resolved
@darunrs
Copy link

darunrs commented Sep 26, 2023

Also, I see that there are two dead links. You can see them under the details of the failing check. They're not on pages we wrote, I think. But we probably want to at least reach out to whoever added it to let them know. Maybe we can update them ourselves if they send us the updated links?

@pkudinov
Copy link
Contributor

Resolves near/queryapi#233

@bucanero bucanero linked an issue Sep 26, 2023 that may be closed by this pull request
@bucanero
Copy link
Collaborator Author

Also, I see that there are two dead links. You can see them under the details of the failing check. They're not on pages we wrote, I think. But we probably want to at least reach out to whoever added it to let them know. Maybe we can update them ourselves if they send us the updated links?

Since the links are not from this PR, I think we can make another PR to review and fix broken links. I think this shouldn't be a blocker to release this useful queryApi article.

@bucanero bucanero merged commit c4383c2 into master Sep 29, 2023
2 of 3 checks passed
@bucanero bucanero deleted the bucanero/qapi-context branch September 29, 2023 17:11
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.

Create a documentation page for context.db.insert
3 participants