-
Notifications
You must be signed in to change notification settings - Fork 371
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
Conversation
Your Render PR Server URL is https://near-docs-pr-1500.onrender.com. Follow its progress at https://dashboard.render.com/static/srv-ck691oo8elhc7392qmlg. |
There was a problem hiding this 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.
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? |
Resolves near/queryapi#233 |
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. |
No description provided.