Skip to content
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/playground: document all its tricks #32294

Closed
bradfitz opened this issue May 28, 2019 · 4 comments
Closed

x/playground: document all its tricks #32294

bradfitz opened this issue May 28, 2019 · 4 comments
Labels
Documentation FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@bradfitz
Copy link
Contributor

The playground is underdocumented:

  • test mode
  • multiples files, mod files
  • images
  • sleeps
  • clearing screen

Document & link from play.golang.org.

@bradfitz bradfitz added Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done. labels May 28, 2019
@gopherbot gopherbot added this to the Unreleased milestone May 28, 2019
@bradfitz
Copy link
Contributor Author

/cc @dmitshur @ysmolsky

@ysmolski
Copy link
Member

Thanks, I agree, especially after the addition of modules. I saw couple of times in tickets people raising eyebrows when they hear about playground having testing. How do we proceed on this beyond extending the about page? It seems to be that nobody reads the about page. Maybe writing a post for Go blog?

Also should we document and expose the way multifiles supported via txtar or wait until we have some kinda non-text interface for it?

I admit, I was distracted heavily from playground by my job, and I have lot's of unclosed playground tickets here :-)

@bradfitz
Copy link
Contributor Author

I think to the right of the Share button we should have:

Examples: [  fun trick 1             \/ ]
          [  fun trick 2                ]
          [  fun trick 3                ]
          [  fun trick 4                ]
          [  fun trick 5                ]
          [  fun trick 6                ]

And have those pre-load some representative features (multi-files, tests, images, sleep animations w/ clearing the screen, etc).

That would make it more prominent.

The golang.org homepage has something similar:

Screen Shot 2019-05-29 at 7 58 35 AM

@gopherbot
Copy link

Change https://golang.org/cl/216359 mentions this issue: playground: add examples to demonstrate tricks

@golang golang locked and limited conversation to collaborators Mar 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

3 participants