Skip to content

documentation: expose src/examples in README and website #2052

Open
@soypat

Description

@soypat

Some folk need practical examples to start writing code. It would be great if the examples were easily accessible from the README.md, or even better: there was a page on tinygo.org which had the list of examples. It is not clear when starting with tinygo what the examples/... directory is and where it lives. We should make it clearer!

Ideas:

  • Add examples link to tinygo.org/getting-started/overview/
  • Add examples link to tinygo.org/docs/reference or tinygo.org/docs/tutorials, whichever fits best
  • Add text to readme, i.e.: The examples/blinky code is contained under the src/examples directory. this directory contains many other examples to get you up and going with tinygo [add link here]

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions