-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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 "search stats" investigation #2042
Comments
I'm gonna go first: Keyword:
|
Keyword :
|
Keyword :
|
Ooh, especially glad someone chose to do |
@sarah11918 how do you feel about the work already done ? does it need details ? is it enough for your needs ? |
@the-dijkstra I'll be looking at this more closely today/tomorrow and will provide some feedback! Sorry, didn't mean to go radio silent on you, but was just getting a rather large PR put together this week first. 😄 |
haha no worries @sarah11918, I just wanted to make sure we are on a good path. good luck with the the other PR 😄 |
OK, so these are GREAT, and I'm loving the screenshots of the results! @dreyfus92 @the-dijkstra I mean, I'm not loving the results.. onClick and script are terrible! But this is so incredibly helpful! It's great for docs planning, for sure. I'm hoping more people step up, but as you have time to try more of these, please do! ❤️ 🚀 |
Keyword:
|
These are so helpful! Thank you all. I hadn’t noticed that weird thing showing in both the |
Keyword :
|
I find it super-interesting that our CSS & Styling page was not a hit for Tailwind! Not bad... just interesting! |
Keyword : props 1.-How many different pages were represented by these 5 results? There are 4 different pages. 2.-Was the top result the "best" suggestion (in your mind - the most helpful/general page on the topic)? If not, was the first search term result at least a "good" suggestion? The fourth result is the best result in my opinion. 3.-Was a page entirely missing from the results that probably should have been included? (e.g. You searched for Markdown and did not see "Markdown & MDX" as one of the 5 results.) No, I don't think there are missing pages. 4.-Do you think more results would be helpful for this search term? No, I don't think so. 5.-Do you feel that someone looking at the 5 results gets enough info about each search result to know the best one to choose? Yes, the results help you get a good grasp of how props work within |
I just did Keyword : How many different pages were represented by these 5 results? There are 5 different pages. Was the top result the "best" suggestion (in your mind - the most helpful/general page on the topic)? If not, was the first search term result at least a "good" suggestion? No. The top 4 results were all error messages. These are helpful to show up, but should they really show up instead of any reference or learn material? Maybe Error messages needs its own category? The only other result was from the tutorial. The good news is, it's clearly visible that it's from the tutorial! Was a page entirely missing from the results that probably should have been included? (e.g. You searched for Markdown and did not see "Markdown & MDX" as one of the 5 results.) Yes, neither the API reference page, nor Routing showed up. (There is a separate open issue re: how we describe Do you think more results would be helpful for this search term? If we're going to be including individual error message pages, then yes! 😅 Do you feel that someone looking at the 5 results gets enough info about each search result to know the best one to choose? Nope. |
Oh, interesting. Looks like those error pages are categorised as “Reference” whereas I thought we had decided to give them their own dedicated “Error Reference” category we could de-prioritise. I think if we make sure that’s the case, the relevant Is |
Keyword:
|
How many different pages were represented by these 5 results? 4 Project structure, Imports (static assets section), Routing, & Migrating from SvelteKit Was the top result the "best" suggestion (in your mind - the most helpful/general page on the topic)? If not, was the first search term result at least a "good" suggestion? No, favicon.ico is relevant and belongs in the search, but I feel like the images & static assets page should be number one. Was a page entirely missing from the results that probably should have been included? (e.g. You searched for Markdown and did not see "Markdown & MDX" as one of the 5 results.) I think adding the image guide https://docs.astro.build/en/guides/images/ could be helpful. Depending on use case, svgs can be used with the Astro/Image component. Plus, the page has multiple examples of how to work with svg’s in Astro Do you think more results would be helpful for this search term? In this case I could only find 3 search results are relevant to the svg keyword. Do you feel that someone looking at the 5 results gets enough info about each search result to know the best one to choose? IMO the first two results are good. The third result links to the routing page b/c it just so happens to contain “svg”. I’m assuming the last two are there in case of a svelte typo? (“Migrating from SvelteKit” & “Similarities between SvelteKit and Astro”) |
How many different pages were represented by these 5 results? 2 - Error Reference & API reference Was the top result the "best" suggestion (in your mind - the most helpful/general page on the topic)? If not, was the first search term result at least a "good" suggestion? No, I don't think giving a such a specific error message should be in the top 5 results. I feel like the Astro.glob section of the imports page OR the Astro.glob API reference should be number one. Was a page entirely missing from the results that probably should have been included? (e.g. You searched for Markdown and did not see "Markdown & MDX" as one of the 5 results.) I think adding both the Astro.glob section of the imports page page AND the RSS guide to using glob imports should be in higher in the search results. Another result that could be added could be the Astro.glob() - no matches found section of the troubleshooting page Do you think more results would be helpful for this search term? No, I don't think so Do you feel that someone looking at the 5 results gets enough info about each search result to know the best one to choose? Yes, for the most part. I think the API reference section gives a good idea of how to use Astro.glob() |
CSS
|
I know I'm late to the party but I actually did search some of these in the last couple of days, so adding some notes!
Side note... I'm not sure if this just the style since there's a similar code snippet just before this, but it seems like this code sample should also include |
Thanks @AishaBlake ! Great feedback, and yes, we tyically would show the file name there. Would you like to make a PR to docs to add that? You can find the syntax we use for our code samples here: https://github.com/withastro/docs/blob/main/contributor-guides/writing-and-style-guide.md#code-samples If not, no worries! I'll add that to to the stack of tasks! |
No problem. PR is up! #3992 |
Retiring this issue for now! 🫡 It has served us well, and we will think of things to do in the new year! |
Hey Team Docs!
We have our first "data dump" of the search terms people have been using on the Docs site. Since we know these are all popular searches, we want to make sure that people are being pointed to the best places in docs to answer their questions.
So, we're looking for interested people to a) try searching some of these terms and b) report back here in a reply re: whether you think our search widget is currently helpful to our readers, returning good results etc.
Of particular interest, things like:
And any other observations are welcome!
This is the list of our most-searched for terms in Docs. It's fine if multiple people report back their observations for the same term, but in the interest of getting as many covered as possible, I'll come back periodically and check ones off this list if at least one person has replied with their observations. (And, I might update and add to the questions above too, as I think of new things, so keep checking back!)
🔍 = carried out before search overhaul; 🔎 = carried out after search overhaul
Others:
The text was updated successfully, but these errors were encountered: