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

User Docs #9

Open
4 tasks
Tracked by #1
patflynn opened this issue Jun 17, 2024 · 4 comments
Open
4 tasks
Tracked by #1

User Docs #9

patflynn opened this issue Jun 17, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@patflynn
Copy link

patflynn commented Jun 17, 2024

For Alpha we want to at a minimum:

  • Provide clear introduction to Tessera why it exists and what it's for
  • Provide examples with some docs
  • Provide a smooth guided through the Alpha Call-To-Action
  • Codelab? Can we leverage Go's example code docs support
@patflynn patflynn added this to the alpha milestone Jun 17, 2024
@patflynn patflynn added the epic Parent issue to group together related issues. Should not be fixed until all child issues are closed label Jun 17, 2024
@patflynn patflynn added the documentation Improvements or additions to documentation label Jul 5, 2024
@patflynn patflynn removed the epic Parent issue to group together related issues. Should not be fixed until all child issues are closed label Aug 19, 2024
@mhutchinson
Copy link
Contributor

I think a reasonable exit criteria for this is if a developer with basic knowledge of what a transparency log is (but doesn't necessarily understand tiles) can come to the main Tessera Go Docs and perform the following actions:

  • deploy an example personality and interact with it
  • view the code and understand how the example personality works
  • write their own personality

@roger2hk
Copy link
Contributor

The godoc examples do not work as expected for some reason.

https://pkg.go.dev/github.com/transparency-dev/[email protected]/api/layout

image

@mhutchinson
Copy link
Contributor

It could be that it needs to pull all of Tessera and its deps in order to build that, and it runs out of time?

@roger2hk
Copy link
Contributor

It could be that it needs to pull all of Tessera and its deps in order to build that, and it runs out of time?

I believe so. The Go playground build timeout is 10 seconds.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants