Feedback: Sanity Docs Beta #3330
Replies: 12 comments 15 replies
-
|
Need a detailed guide on Publish Actions in v3. Eg: How to create an auto-generating slug based on the given fields using PublishAction. The v2 method is too complicated. |
Beta Was this translation helpful? Give feedback.
-
|
And thanks for finally enabling github discussions 🥳 |
Beta Was this translation helpful? Give feedback.
-
|
Unfortunately, we haven't done anything to the Document Actions API (yet). Only how you import actions into the new configuration. But we appreciate the feedback! |
Beta Was this translation helpful? Give feedback.
-
|
Other areas to improve in docs:
|
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
Given that we can choose to use the Studio without Typescript, it would be nice to be able to toggle between a |
Beta Was this translation helpful? Give feedback.
-
|
Yeah, this is a conundrum! I think we can make that happen, at least for the code block examples. For inline mention of files we could make some kind of inline object, but I wonder if that would be over-engineering it contra writing |
Beta Was this translation helpful? Give feedback.
-
|
That's a good point about the inline items! I like the idea of using |
Beta Was this translation helpful? Give feedback.
-
|
Perhaps a global toggle between ts and js examples (similar to a dark/light mode toggle), which could modify inline as well? |
Beta Was this translation helpful? Give feedback.
-
|
Would be great to see more about handling and optimizing previews with complex GROQ queries. I was able to remove the old iFrame plugin and API preview code by using components and hitting the groq queries directly. I'm still having trouble with preview load speeds and no hot reloading on editor updates. |
Beta Was this translation helpful? Give feedback.
-
|
For sure @jasonbarone! Improving the developer/editor experience for implementing previews is also something we're looking at. Btw. did you see this new documentation article on performant GROQ? |
Beta Was this translation helpful? Give feedback.
-
|
I'm really interested in input component customization. Would love to see docs and example code |
Beta Was this translation helpful? Give feedback.
-
The original docs are very comprehensive, but there are plenty of tasks that people do all the live-long day that could get extra attention, like the image URL builder. I think they're covered well, even but just to really lay it on thick, perhaps with a different presentation each time, to make sure as many people with as many different learning styles truly get it. Maybe even some wow-factor-but-genuinely-practical-because-people-actually-do-it examples, like async operations that fill in a value in a field. During the preview presentation I loved seeing the USDA autocomplete. I could see so many businesses using something like that even if it were dogfooding their own API. If developers are experienced with a language, or at coding, that doesn't mean they might not want to see an application (ha) of those skills in context. If they're starting out, they might be more engaged if it looks like what they're learning after those basics is something they could get a lot of utility out of. Also the API reference, it was said, is self-generating but unless I'm missing it, when the time comes it'd be cool to have a live-filtering or a search. There is a lot of information and if you stare at the names for too long it sort of bleeds together. Especially with hooks. So if I go in there knowing what I want to refer to, it'd be great to limit the list to the six things that look like that.
Even though there are just a couple pages of the new version, I like the idea that it might build cumulatively. In other words, yes, you can know about each topic at a glance, but if you're already holding my hand by teaching me about schemas with pets that have names, perhaps by the time we roll around to list previews, we're still building on what we made before so we can see how it all ties together. |
Beta Was this translation helpful? Give feedback.
-
|
What's the best way to get notified of all beta docs updates? I tried to look into your repos, but couldn't find anything that I could subscribe to for this. |
Beta Was this translation helpful? Give feedback.
-
|
We don't have any mechanism for that… yet. Maybe we could make a small changelog thingy that relays a list of the last updated articles! |
Beta Was this translation helpful? Give feedback.
-
|
It would be much appreciated. Going to the beta docs every day to look for updates is not very efficient 😄 If you do it with a changelog listing, links to the updated pages would be great! |
Beta Was this translation helpful? Give feedback.
-
|
We shipped the changelog here. |
Beta Was this translation helpful? Give feedback.
-
|
I just thought of another "coverage" thing -- I am reading Carrie and Mike's "Connected Content" book and it's quietly tangible that even though structured content might be a strong alternative for some companies and use cases to the way things have been done up until recently, it's all still "living" information; about midway through one of the interviewees is talking about how well some of their decisions have held up, but in the Slack channels it's a reasonably common occurrence that people are talking about finding-and-replacing fields, switching types, formats and such. If that's going to be people's real-life experience, it might be good to give separate attention to move-making like that -- not because it's v3-specific so much as, if you're already going to deep-dive and massage these things, might as well take advantage of the diving sessions. The mechanisms are in place to do it, but touching anything that might be altered or affective even if you have backups is a scary thing no matter where you are in your development expertise. So something really clear and over about how to handle things we might run into like that. Big important "steps" in the live of a ...er...Sanitarian. To keep the ships from sinking so that all these really thoughtful decisions before coding and all these snazzy conveniences during coding continue to stay afloat and work ship-shape. (I really can't help myself) |
Beta Was this translation helpful? Give feedback.
-
|
I think you're talking about evolving content models and how to migrate data when structures change. I agree that it would be useful to cover some common strategies for this in the docs! |
Beta Was this translation helpful? Give feedback.
-
|
I had this thought, but maybe it's silly. I can't tell you how many times I read an example of code somewhere and I have an immediate thought related to it. For example, if I am on a remote database's documentation, and it says "We have the simplest auth system in the world," and they show really basic examples that all involve five fields, like ID, first name, last name, etc. but then the final example is, "and here's how you'd make a function that triggers the addition of a new user to the table when they've completed signup" and that example only pushes the ID in... ...I am now super curious how to add in all the non-ID stuff if the format is completely new to me (in other words, if it's not as simple as just adding more things to the list, copying pasting, what not...basic developer inference skills. It might be cool if inline in the documentation there was a button to ask a question, as if to say "I want to know specifically about this" and fire off those questions sort of pre-categorized for context. Whether that goes here, in Slack, to your own internal tool, whatnot. So much of asking questions nowadays is hesitancy, because of the "getting on the same page," the volleying back and forth. In real life you'd pull someone aside and say, "What's that bit mean." "Oh it means this," so having the direct connection to the information established right out of the gate, with context, feels like it maybe eliminates some of those barriers. |
Beta Was this translation helpful? Give feedback.
-
|
Interesting idea @vincentjflorio! Most of our effort towards GA will be on just getting the v3 APIs documented. But we're definitively interested in adding more helpful features to the doc site as well. |
Beta Was this translation helpful? Give feedback.
-
|
Something that took me a while today to figure out was how to get the dataset (production/development) from an environment variable. |
Beta Was this translation helpful? Give feedback.
-
|
Upon further testing I can't get this to work properly. I have a I have removed my dataset: import.meta.env.SANITY_STUDIO_DATASET,But when I run When I run It would be helpful if it printed the value also. Im running sanity v3.0.0-dev-preview.15 |
Beta Was this translation helpful? Give feedback.
-
|
In the v2 docs |
Beta Was this translation helpful? Give feedback.
-
|
I'm surprised that this issue has existed for months with any v3 project but still get no response |
Beta Was this translation helpful? Give feedback.
-
|
Maybe add an example here https://beta.sanity.io/docs/platform/studio/v2-to-v3/custom-input for a custom block content / portable preview component, like how to customize it in v3 style |
Beta Was this translation helpful? Give feedback.
-
|
Is the blockEditor field mentioned here still a thing? |
Beta Was this translation helpful? Give feedback.
-
We have shipped a beta version of the new Sanity Docs. We are reworking the Sanity.io documentation for a couple of reasons:
The documentation is still a work in progress, but we do want to hear from you:
Beta Was this translation helpful? Give feedback.
All reactions