Skip to content

Create a GopherJS documentation site #1143

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

Open
nevkontakte opened this issue Aug 25, 2022 · 3 comments
Open

Create a GopherJS documentation site #1143

nevkontakte opened this issue Aug 25, 2022 · 3 comments
Labels
documentation NeedsHelp Community contributions are welcome for this feature!

Comments

@nevkontakte
Copy link
Member

I think one of the biggest pain points for GopherJS users (current and potential) is the lack of accessible and comprehensive user documentation. We have some bits scattered between the README, docs directory and wiki, but I wouldn't call that user-friendly.

A simple site with organized tutorials, documentation, FAQs, etc. would be a great improvement. It doesn't have to be anything sophisticated, just a static site would be more than enough, most of the effort would be dedicated to simply organizing the existing material and maybe filling in some gaps.

We already have GitHub Pages repository we could use. We could also pick up a per-made template like Docsy. AFAICT that's what TinyGo uses for their web site.

@nevkontakte nevkontakte added documentation NeedsHelp Community contributions are welcome for this feature! labels Aug 25, 2022
@flimzy
Copy link
Member

flimzy commented Aug 26, 2022

As an alternative/suppliment, we could also take better advantage of GoDoc and the README.md, which requires no additional volunteer upkeep effort on our part.

https://pkg.go.dev/github.com/gopherjs/gopherjs

@alidevhere
Copy link

I would like to take this issue, if it's still relevant.

@nevkontakte
Copy link
Member Author

@alidevhere yes, this is very much relevant!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation NeedsHelp Community contributions are welcome for this feature!
Projects
None yet
Development

No branches or pull requests

3 participants