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
x/tools/godoc: make codewalks more accessible to third parties #14369
Comments
Bump on this. I wrote a codewalk XML, before reading the how-to-write-codewalks part and realized that it only works for $GOROOT. Felt like a gut punch. |
OK I'm irritated enough I'm willing to take a stab at this. How's this for a plan:
|
I think it would be preferable to show them under |
Does introducing a format other than XML fall under the scope of making the codewalks more accessible from an author perspective? |
I took a stab at it. It wasn't difficult. Here's how it looks like: Some considerations: the code right now scans for multiple The endpoint is Waiting comments from the Go team in particular |
Please send a CL.
Can you expand on this? I don't understand the second sentence.
It seems more natural to me that these should be
where |
Then they can be listed in /doc/codewalk/ as well. |
So the current I have this in the template (call this
If there is only one Will send a CL when this is more complete. |
@adg Just to double check on the structure of the program, before I go ahead this weekend and implement it fully. Should I implement/augment the |
@chewxy it's been a while since I looked at the code. Maybe just send out what you've got and I can help you iterate on the design from there? |
yep ok. I've not actually started on it. Will do soon |
Obviously this hasn't happened yet, but I would still like it to. Which begs the question though, where it should live at this point:
|
The general trend seems to be toward splitting things out of godoc. I think the last option makes sense, and is at least a sensible starting point regardless of where it ends up. |
It would be great if it was easier to write and distribute codewalks as documentation. The codewalk tool in godoc is pretty amazing. Writing a complete usecase of a library and a codewalk explaining it all would be an amazing way to complement testable examples and API documentation.
This could either happen by also loading codewalks from GOPATH-packages and showing them in godoc (and on godoc.org) or by factoring them into a separate tool which could then run hosted on appengine similar to go-talks.appspot.com.
The text was updated successfully, but these errors were encountered: