readme: provide more context on maintainers and give a testscript overview with links #225
Conversation
|
It's worth knowing that the |
|
Hi @bitfield 👋
Ah, interesting, TIL. I guess I don't know how often people are browsing the root https://pkg.go.dev/github.com/rogpeppe/go-internal on pkg.go.dev (vs. browsing API for an importable package), and I guess the "Links" link in the right-hand pane hasn't been jumping out to me personally. My thought was to put the link in a sentence along with words like "introduction" and "nice" and "series" to encourage interested people to click, but I don't have a strong opinion. As the target of said link, any preference regarding which form to use? |
Borrowed the better text from rogpeppe#225
Borrowed the better text from rogpeppe#225
* Better README text Borrowed the better text from rogpeppe#225 * add explanation about link section and try if it still works with ## instead of #
|
I tested with https://github.com/fortio/testscript/blob/v0.3.1/README.md and you can use ## for links so it's smaller when looking on github and yet still on pkg.go.dev (and I guess probably ### or #### would also work) |
|
SGTM :) Perhaps worth making a mention that testscript and txtar were both originally written by Russ. We don't want to give the impression that we came up with the idea. |
…ntion original author, other minor adjustments Mostly based on review feedback.
|
Thanks for the quick feedback! I think I addressed your comments. PTAL. |
Should be the last tweak from me in this series, pending further feedback.
|
You don't want to keep/add back ### Links for pkg.go.dev? |
Help give some context for people who might be evaluating using this repo and are wondering things like:
Obviously, someone can hunt around to determine many of these things on their own, but intent is to help make that process more efficient.
Updates #196