Skip to content

Remove prefix for RFC (??) & Improve docs #197

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

Merged
merged 5 commits into from
Oct 23, 2022
Merged

Remove prefix for RFC (??) & Improve docs #197

merged 5 commits into from
Oct 23, 2022

Conversation

xxchan
Copy link
Contributor

@xxchan xxchan commented Oct 18, 2022

Search from RFC index, instead of CanIUse index.

@Folyd
Copy link
Member

Folyd commented Oct 19, 2022

Thanks, @xxchan. We have a :rfc command to search RFC already, I prefer to remove the ?? sigil since too many sigils are hard for users to remember. RFC is a low-frequency search, the :rfc command is enough. What do you think?

@xxchan
Copy link
Contributor Author

xxchan commented Oct 19, 2022

@Folyd Fair enough. I found :rfc is more powerful, e.g., it can also search for RFC number. But I think the doc isn't accessible enough for users to find this feature..

First, it's under the "Commands system" section. The difference between prefix and command seems unclear. Second, it says :rfc - Show all Rust RFC list -- I didn't even know I could search at all 🤣

@Folyd
Copy link
Member

Folyd commented Oct 19, 2022

Yes, commands also support search via keywords. The docs are outdated, do you mind fixing it BTW? 😅

The difference between prefix and command seems unclear.

Normally, the sigil is suitable for high-frequency search, otherwise, let's make it a command.

@xxchan
Copy link
Contributor Author

xxchan commented Oct 19, 2022

.. And I also felt confused how to see the full list since there's only a few rows. Now I just came across the paging feature while browsing the doc. I think it can be put to a more noticable place instead of the end of the doc 🤣

@xxchan
Copy link
Contributor Author

xxchan commented Oct 19, 2022

Yes I can help improve the docs

@xxchan
Copy link
Contributor Author

xxchan commented Oct 19, 2022

Another thing is that the doc itself is a little bit hard to find too. I was always trying looking for a doc button at the upper-right corner, and couldn't notice the "explore more" at the bottom and didn't know I can scroll down the page..

@Folyd
Copy link
Member

Folyd commented Oct 19, 2022

.. And I also felt confused how to see the full list since there's only a few rows. Now I just came across the paging feature while browsing the doc. I think it can be put to a more noticable place instead of the end of the doc 🤣

image

I thought I tried my best to tell the user how to use the extension, but the reality is (😅):

@Folyd
Copy link
Member

Folyd commented Oct 19, 2022

Yes I can help improve the docs

That would be great. Thanks ❤️

@Folyd
Copy link
Member

Folyd commented Oct 19, 2022

Another thing is that the doc itself is a little bit hard to find too. I was always trying looking for a doc button at the upper-right corner, and couldn't notice the "explore more" at the bottom and didn't know I can scroll down the page..

Any idea on how to improve it?

@xxchan
Copy link
Contributor Author

xxchan commented Oct 21, 2022

For the pagination hint, is it possible to put it at the lower-right corner?
image

@xxchan
Copy link
Contributor Author

xxchan commented Oct 21, 2022

Another thing is that the doc itself is a little bit hard to find too. I was always trying looking for a doc button at the upper-right corner, and couldn't notice the "explore more" at the bottom and didn't know I can scroll down the page..

Any idea on how to improve it?

Some possible ideas:

  • Add some animation for the "Explore More" button
  • Add an additional Docs button at the upper-right corner. It either goes to another page, or functions the same as "Explore More".

@Folyd
Copy link
Member

Folyd commented Oct 22, 2022

For the pagination hint, is it possible to put it at the lower-right corner? image

Yes, it's possible. I'll give it a try.

@Folyd
Copy link
Member

Folyd commented Oct 22, 2022

Another thing is that the doc itself is a little bit hard to find too. I was always trying looking for a doc button at the upper-right corner, and couldn't notice the "explore more" at the bottom and didn't know I can scroll down the page..

Any idea on how to improve it?

Some possible ideas:

  • Add some animation for the "Explore More" button
  • Add an additional Docs button at the upper-right corner. It either goes to another page, or functions the same as "Explore More".

Good idea. 👍

Copy link
Member

@Folyd Folyd left a comment

Choose a reason for hiding this comment

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

LGTM, thanks. However, extension/search/rfc.js should be deleted.

@xxchan xxchan changed the title Improve RFC search Remove prefix for RFC (??) & Improve docs Oct 22, 2022
@xxchan xxchan requested a review from Folyd October 22, 2022 14:09
@Folyd Folyd merged commit ca03c66 into huhu:master Oct 23, 2022
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.

2 participants