Comments (8)
So, for suggesting users to do PR for minor stuff, I suggest adding a "Edit this page" link/button somewhere. Could be right next to the page title, or perhaps at the top-bottom of the TOC sidebar on the right.
For the feedback form, SGTM. Most docs I've used in the past, though, rather than a typeform use a simple footer with π / π buttons (which, after clicking, show a simple feedback form, without the need to open a different page), a pointer to edit the page, and a pointer to get further help from the community. (See the footer on this page, for instance). I think this could be good.
from gno.
The reason I proposed a written feedback form is because I think that when we get feedback, it will usually be a critique, "please improve this", typo fixes, etc. - I don't believe people will go out of their way to "thumbs up" a page, and even if they do, IMO its only a nice-to-have metric, doesn't really tell us what was good (or for the case of a thumbs down, what was bad). The optimal option in this case is to have an optional textbox in the form, like on the Github page Morgan linked.
Regarding the hint to help people understand they can edit/improve the pages, I would add a pen icon link next to the top of content in the docs or a button linked to GitHub at the bottom of the page, under the next page here
@alexiscolin
Please do, this is definitely something we want. I think beginning of page, top right makes most sense, but we can also have it below where you pointed out, possibly with a "Last updated on xyz date", like below, replacing the smileys (the example below is GitBook :)
We can point people to our Discord, just like in the image - WDYT @alexiscolin? I would like to keep this out of the page markdown content itself, so if we choose to do this, it would be good to have it as a default element for each page.
I think writing & maintaining our custom feedback form might take some more effort than needed - can we use some pre-existing snippet? I linked a couple I found with a quick Google search.
All other solutions I found include adding something else (ie this, this, or this), or custom making a widget.
from gno.
So, for suggesting users to do PR for minor stuff, I suggest adding a "Edit this page" link/button somewhere. Could be right next to the page title, or perhaps at the top-bottom of the TOC sidebar on the right.
For the feedback form, SGTM. Most docs I've used in the past, though, rather than a typeform use a simple footer with π / π buttons (which, after clicking, show a simple feedback form, without the need to open a different page), a pointer to edit the page, and a pointer to get further help from the community. (See the footer on this page, for instance). I think this could be good.
I like this idea, Docusaurus actually supports this kind of functionality out of the box, albeit we haven't configured it yet since the docs were not live up until recently
from gno.
My inspiration for this was the following from the Arc browser:
![Screenshot 2024-01-15 at 10 39 18](https://private-user-images.githubusercontent.com/33522493/296714223-0f986193-0a59-45ad-b2cc-29626c61bad2.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjExMDcwOTgsIm5iZiI6MTcyMTEwNjc5OCwicGF0aCI6Ii8zMzUyMjQ5My8yOTY3MTQyMjMtMGY5ODYxOTMtMGE1OS00NWFkLWIyY2MtMjk2MjZjNjFiYWQyLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzE2VDA1MTMxOFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTMwYTk5NTRlNzgyMWQzMDQ0OWQxYjgxZDdmZTUyNWZmMjA3MDI5YjAwNDFlYTljZGViNmQzNGI4NmFiZDNjMGYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.j0G-OVJXe67BdfBHhp_0b3T6ORAO77DWRC6EGOGk4VM)
It's an easily accessible general feedback form for the product. Let me look into the Docusaurus feedback functionality.
from gno.
I like this idea, Docusaurus actually supports this kind of functionality out of the box, albeit we haven't configured it yet since the docs were not live up until recently
I might be missing something, but I don't see anything related to a feedback form in the Docusaurus page you linked, and nothing is popping up on the Docusaurus docs or a wider Google search.
All other solutions I found include adding something else (ie this, this, or this), or custom making a widget.
I propose adding a single-pager to the docs (to the left sidebar) encouraging people to contribute to the docs if they see something that is wrong/outdated/could be done better, and if they just want to leave feedback, we will have a link to a Typeform/Google form, or any other form we usually use. WDYT?
from gno.
Hey there!
I agree with @thehowl the π / π buttons
system is very good. Because we can get info with one click and then more details if user wants. So we can get info easily and more data easier (clicking is less time consuming than writing).
It's also a smooth way to let users enter into the flow of giving feedback. It's alway a good move to start with something simple (as a click) before asking more complicated (writing).
But yeah, to get that kind of system, we would have to code and support
a small React plugin that could be linked to a google form API/request to fill a Google Sheets (or same kind).
Regarding the hint to help people understand they can edit/improve the pages, I would add a pen icon link next to the top of content in the docs or a button linked to GitHub at the bottom of the page, under the next page here:
WDYT @leohhhn ?
from gno.
I think writing & maintaining our custom feedback form might take some more effort than needed - can we use some pre-existing snippet? I linked a couple I found with a quick Google search.
Yeah I fully agree with you. It's an important effort. However the links you shared implied to build components. So It's almost a must have. At least a small component.
The reason I proposed a written feedback form is because I think that when we get feedback, it will usually be a critique, "please improve this", typo fixes, etc. - I don't believe people will go out of their way to "thumbs up" a page, and even if they do, IMO its only a nice-to-have metric, doesn't really tell us what was good (or for the case of a thumbs down, what was bad). The optimal option in this case is to have an optional textbox in the form, like on the Github page Morgan linked.
I agree here as well. The thumbs up option is just an excuse to let people see it's also possible. But I think Morgan proposal from GitHub is the best. As I said, we can get a first info from users when they click on thumbs-down/up and then more info with the optional form.
We can point people to our Discord, just like in the image - WDYT @alexiscolin? I would like to keep this out of the page markdown content itself, so if we choose to do this, it would be good to have it as a default element for each page.
So we would go for "update in Github" icon at the top and a texts with "more info on Discord" + "update in Github" above the footer? Of course outside of MD content π
from gno.
Addressed in gnolang/docs.gno.land#16. Thanks a ton @alexiscolin !!
from gno.
Related Issues (20)
- uassert/urequire: Wrong message when strings are not the same. HOT 1
- uassert/urequire: Messages from PanicsWithMessage method are inverted HOT 2
- [examples] Improve AVL interface to take in any type of ID HOT 3
- PR Review throttling HOT 1
- [govdao] Make `r/gov/dao` proposals fee-based for non-members
- [chain] Add a more robust e2e node / cluster testing framework
- CI should detect problems in PRs, not after merging HOT 1
- CI: detect outdated docs' examples
- gnofaucet should have docker images/binaries HOT 1
- "Go version autonomy" for important packages used by the keeper, like go/types and go/format
- [ops] Add release flow for `gnofaucet`
- feature request: Ledger hardware wallet support for validator addresses
- Move GnoVM testing logic within pkg/gnolang; separate from `gno test` logic
- [GnoVM] Better error message with `MsgRun` HOT 1
- javascript: getElementById("source") not always available
- change default genesis package creator, and add way to configure it HOT 1
- Validator resolves old IP address after sentry IP change when using FQDN HOT 1
- p/demo/mux: support query strings HOT 1
- integrate p/demo/avl/pager with existing examples
- Discord roles HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from gno.