M2 icon indicating copy to clipboard operation
M2 copied to clipboard

"Report" button for documentation

Open mahrud opened this issue 5 years ago • 7 comments

It would be nice to have a report button on the online documentation so people can report issues without going through the trouble of emailing or making a github issue. It would also make it easy to go through a list of reported documentation issues quickly.

For instance, I just found a bug in width(Net), which says:

For a string, the width and the height are the same.

But this is so minor that even opening an issue seems like an overkill.

mahrud avatar Sep 03 '20 03:09 mahrud

What would the button do?

DanGrayson avatar Sep 03 '20 11:09 DanGrayson

Maybe open a form to let users submit a short description of the issue? Maybe backed by google forms or something easy.

mahrud avatar Sep 03 '20 11:09 mahrud

How about just having a link to https://github.com/Macaulay2/M2/issues/new ?

DanGrayson avatar Sep 03 '20 11:09 DanGrayson

Most people don't have a GitHub account.

On Thu, Sep 3, 2020, 6:16 AM Daniel R. Grayson [email protected] wrote:

How about just having a link to https://github.com/Macaulay2/M2/issues/new ?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Macaulay2/M2/issues/1484#issuecomment-686420440, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAYAPRUEYRLU5TXMNYY4ZKDSD53KJANCNFSM4QUGN5KA .

mahrud avatar Sep 03 '20 11:09 mahrud

It's not onerous to set one up, and the results are great.

DanGrayson avatar Sep 03 '20 11:09 DanGrayson

Sure, that'll do. I'll do it in #1454.

mahrud avatar Sep 03 '20 12:09 mahrud

Actually, change of plans, that pull request is done, so I'll leave this for a future PR.

mahrud avatar Sep 04 '20 13:09 mahrud